APIHub
Back to Explore

Custom Workflow Actions

Create custom workflow actions

Uncategorized
apiKeyQuery
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/automation/v4/actions/callbacks/complete

Complete a batch of callbacks

POST

/automation/v4/actions/callbacks/{callbackId}/complete

Complete a callback

  • callbackId (path, required) — The ID of the target app.
GET

/automation/v4/actions/{appId}

Get all custom actions

  • limit (query, limit) — Maximum number of results per page.
  • after (query) — The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
  • archived (query) — Whether to include archived custom actions.
  • appId (path, required)
DELETE

/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}

Delete a custom action function

  • definitionId (path, required) — The ID of the custom workflow action
  • functionType (path, required) — The type of function. This determines when the function will be called.
  • functionId (path, required) — The ID qualifier for the function. This is used to specify which input field a function is associated with for `PRE_FETCH_OPTIONS` and `POST_FETCH_OPTIONS` function types.
  • appId (path, required)
POST

/automation/v4/actions/{appId}

Create new custom action

  • appId (path, required)
DELETE

/automation/v4/actions/{appId}/{definitionId}

Archive a custom action

  • definitionId (path, required) — The ID of the custom workflow action.
  • appId (path, required)
GET

/automation/v4/actions/{appId}/{definitionId}

Get a custom action

  • definitionId (path, required) — The ID of the custom workflow action.
  • archived (query) — Whether to include archived custom actions.
  • appId (path, required)
PATCH

/automation/v4/actions/{appId}/{definitionId}

Update a custom action

  • definitionId (path, required) — The ID of the custom workflow action.
  • appId (path, required)
GET

/automation/v4/actions/{appId}/{definitionId}/functions

Get all custom action functions

  • definitionId (path, required) — The ID of the custom workflow action.
  • appId (path, required)
DELETE

/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}

Delete a custom action function

  • definitionId (path, required) — The ID of the custom workflow action.
  • functionType (path, required) — The type of function. This determines when the function will be called.
  • appId (path, required)
GET

/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}

Get a custom action function

  • definitionId (path, required) — The ID of the custom workflow action.
  • functionType (path, required) — The type of function. This determines when the function will be called.
  • appId (path, required)
PUT

/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}

Create or replace a custom action function

  • definitionId (path, required) — The ID of the custom workflow action.
  • functionType (path, required) — The type of function. This determines when the function will be called.
  • appId (path, required)
GET

/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}

Get a custom action function

  • definitionId (path, required) — The ID of the custom workflow action.
  • functionType (path, required) — The type of function. This determines when the function will be called.
  • functionId (path, required) — The ID qualifier for the function. This is used to specify which input field a function is associated with for `PRE_FETCH_OPTIONS` and `POST_FETCH_OPTIONS` function types.
  • appId (path, required)
PUT

/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}

Create or replace a custom action function

  • definitionId (path, required) — The ID of the custom workflow action.
  • functionType (path, required) — The type of function. This determines when the function will be called.
  • functionId (path, required) — The ID qualifier for the function. This is used to specify which input field a function is associated with for `PRE_FETCH_OPTIONS` and `POST_FETCH_OPTIONS` function types.
  • appId (path, required)
GET

/automation/v4/actions/{appId}/{definitionId}/revisions

Get all revisions for a custom action

  • definitionId (path, required) — The ID of the custom workflow action
  • limit (query, limit) — Maximum number of results per page.
  • after (query) — The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
  • appId (path, required)
GET

/automation/v4/actions/{appId}/{definitionId}/revisions/{revisionId}

Get a revision for a custom action

  • definitionId (path, required) — The ID of the custom workflow action.
  • revisionId (path, required) — The version of the custom workflow action.
  • appId (path, required)

16 endpoints auto-detected

Authentication

This API uses an API key, passed as the "hapikey" query parameter. No OAuth required.

curl -X POST \
  "https://api.hubapi.com/automation/v4/actions/callbacks/complete?hapikey=YOUR_API_KEY"

api.hubapi.com · HTTPS only