Hubapi Automation is the HubSpot automation API for working with workflow and automation features in HubSpot.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Hubapi Automation

Hubapi Automation is the HubSpot automation API for working with workflow and automation features in HubSpot.

Base URL: https://api.hubapi.com
Auth: query:hapikey (pass your key via the apiKey input)

Operations

get_automation_v4_actions_appid_getpage — GET /automation/v4/actions/{appId} — Get all custom actions
get_automation_v4_actions_appid_definitionid_get — GET /automation/v4/actions/{appId}/{definitionId} — Get a custom action
get_automation_v4_actions_appid_definitionid_fun — GET /automation/v4/actions/{appId}/{definitionId}/functions — Get all custom action functions
get_automation_v4_actions_appid_definitionid_rev — GET /automation/v4/actions/{appId}/{definitionId}/revisions — Get all revisions for a custom action
post_automation_v4_actions_callbacks_complete_co — POST /automation/v4/actions/callbacks/complete — Complete a batch of callbacks
post_automation_v4_actions_callbacks_callbackid_ — POST /automation/v4/actions/callbacks/{callbackId}/complete — Complete a callback

Inputs

apiKey — your hubapi-automation API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: get_automation_v4_actions_appid_getpage
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: get_automation_v4_actions_appid_getpage, get_automation_v4_actions_appid_definitionid_get, get_automation_v4_actions_appid_definitionid_fun, get_automation_v4_actions_appid_definitionid_rev, post_automation_v4_actions_callbacks_complete_co, post_automation_v4_actions_callbacks_callbackid_
`appId`	string	no	—	Path parameter appId (required by some operations).
`callbackId`	string	no	—	Path parameter callbackId (required by some operations).
`definitionId`	string	no	—	Path parameter definitionId (required by some operations).
`query`	string	no	—	Optional query params as a JSON object string, e.g. {"limit": 10}.
`body`	string	no	—	Request body as a JSON object string (for create/update operations).