HubSpot

Custom Workflow Actions

Create custom workflow actions

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Create custom workflow actions

Endpoints 16

Definitions

  • GETGet all custom actions/automation/v4/actions/:appId?limit=0&after=string&archived=falseReturns a list of all custom workflow actions.
  • POSTCreate new custom action/automation/v4/actions/:appIdCreates a new custom workflow action.
  • GETGet a custom action/automation/v4/actions/:appId/:definitionId?archived=falseReturns a single custom workflow action with the specified ID.
  • DELETEArchive a custom action/automation/v4/actions/:appId/:definitionIdArchives a single custom workflow action with the specified ID. Workflows that currently use this custom action will stop attempting to execute the action,…
  • PATCHUpdate a custom action/automation/v4/actions/:appId/:definitionIdUpdates a custom workflow action with new values for the specified fields.

Functions

  • GETGet all custom action functions/automation/v4/actions/:appId/:definitionId/functionsReturns a list of all functions that are associated with the given custom workflow action.
  • GETGet a custom action function/automation/v4/actions/:appId/:definitionId/functions/:functionTypeReturns the given function for a custom workflow action.
  • PUTCreate or replace a custom action function/automation/v4/actions/:appId/:definitionId/functions/:functionTypeCreates or replaces a function for a custom workflow action.
  • DELETEDelete a custom action function/automation/v4/actions/:appId/:definitionId/functions/:functionTypeDelete a function for a custom workflow action. This will remove the function itself as well as removing the association between the function and the custom…
  • GETGet a custom action function/automation/v4/actions/:appId/:definitionId/functions/:functionType/:functionIdReturns the given function for a custom workflow action.
  • PUTCreate or replace a custom action function/automation/v4/actions/:appId/:definitionId/functions/:functionType/:functionIdCreates or replaces a function for a custom workflow action.
  • DELETEDelete a custom action function/automation/v4/actions/:appId/:definitionId/functions/:functionType/:functionIdDelete a function for a custom workflow action. This will remove the function itself as well as removing the association between the function and the custom…

Revisions

  • GETGet all revisions for a custom action/automation/v4/actions/:appId/:definitionId/revisions?limit=0&after=stringReturns a list of revisions for a custom workflow action.
  • GETGet a revision for a custom action/automation/v4/actions/:appId/:definitionId/revisions/:revisionIdReturns the given version of a custom workflow action.

Callbacks

  • POSTComplete a batch of callbacks/automation/v4/actions/callbacks/completeCompletes the given action callbacks.
  • POSTComplete a callback/automation/v4/actions/callbacks/:callbackId/completeCompletes the given action callback.

API details

Base URL
https://api.hubapi.com
Authentication
An API key in the hapikey query parameter
An API key in the hapikey query parameter
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the private-app-legacy header
Operations
16 operations on 9 pathsGET 7POST 3DELETE 3PUT 2PATCH 1
Main resources
Functions 7Definitions 5Callbacks 2Revisions 2
Response formats
application/json
Description format
OpenAPI 3.0.1, API version v4
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Custom Workflow Actions in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Custom Workflow Actions collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the hapikey query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get all custom actions” (GET /automation/v4/actions/:appId?limit=0&after=string&archived=false), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Custom Workflow Actions?

Create custom workflow actions It is listed under Other and has 16 endpoints.

Who publishes the Custom Workflow Actions?

It is listed from HubSpot's public API description (an OpenAPI document), not published by HubSpot on Swastik Codes. Anyone who controls hubapi.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Custom Workflow Actions?

Requests go to https://api.hubapi.com. Endpoint paths are added to this base URL.

How do I authenticate with the Custom Workflow Actions?

It accepts 4 methods: an API key in the hapikey query parameter; an API key in the hapikey query parameter; OAuth 2.0 (authorization code flow) with 1 scope; an API key in the private-app-legacy header.

How many endpoints does the Custom Workflow Actions have?

16 operations on 9 paths (7 GET, 3 POST, 3 DELETE, 2 PUT, 1 PATCH). The largest groups are Functions, Definitions, Callbacks, Revisions.

Is forking the Custom Workflow Actions free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.