Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot Action Definitions API

Operations to create and manage custom workflow action definitions

HubSpot Action Definitions API is one of 93 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 652 JSON Schema definitions.

Tagged areas include Action Definitions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 652 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://api.hubapi.com.

5 operations 2 paths 14 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

HubSpot Action Definitions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Action Definitions 5

Operations to create and manage custom workflow action definitions

GET
/automation/v4/actions/{appId}
Hubspot List Action Definitions
listActionDefinitions 4 params → 200400401500
POST
/automation/v4/actions/{appId}
Hubspot Create an Action Definition
createActionDefinition 1 param body → 201400401500
GET
/automation/v4/actions/{appId}/{definitionId}
Hubspot Retrieve an Action Definition
getActionDefinitionById 3 params → 200400401404500
PATCH
/automation/v4/actions/{appId}/{definitionId}
Hubspot Update an Action Definition
updateActionDefinitionById 2 params body → 200400401404500
DELETE
/automation/v4/actions/{appId}/{definitionId}
Hubspot Archive an Action Definition
archiveActionDefinitionById 2 params → 204401404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ActionDefinition (10 properties), ActionDefinitionInput (7 properties), Error (7 properties), ActionDefinitionPatch (7 properties). Each schema is shown below with its type and property counts.

ActionFunctionReference
object
A reference to a function associated with an action
2 properties 2 required
OutputField
object
An output field returned by the action
1 property 1 required
FieldTypeDefinition
object
Definition of a field's type and configuration
6 properties 2 required
ErrorDetail
object
Detailed error information
5 properties 1 required
ObjectRequestOptions
object
Options for requesting CRM object data
1 property
ActionDefinitionInput
object
Input for creating a new action definition
7 properties 3 required
Paging
object
Pagination information
1 property
ActionDefinition
object
A custom workflow action definition
10 properties 5 required
ActionLabels
object
Human-readable labels for the action
4 properties 1 required
ActionDefinitionCollection
object
A paginated collection of action definitions
2 properties 1 required
ActionDefinitionPatch
object
Input for updating an action definition
7 properties
Error
object
An error response
7 properties 3 required
FieldOption
object
An option for an enumeration field
3 properties 2 required
InputField
object
An input field for the action
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-action-definitions-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

HubSpot Posts API
HubSpot URL Redirects API
HubSpot Pipelines API
HubSpot Products API
HubSpot Line Items API
HubSpot Quotes API
HubSpot CRM Properties API
HubSpot Owners API
HubSpot CRM Imports API
HubSpot Custom Objects API
HubSpot Marketing Events API
HubSpot Forms API