How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot Automation Actions v4 API

HubSpot Automation Actions v4 — 18 operation(s) from HubSpot's published OpenAPI.

HubSpot Automation Actions v4 API is one of 144 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 692 JSON Schema definitions.

Tagged areas include Automation and Actions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 692 JSON Schemas.

This API exposes 18 operations across 10 paths, organized into 4 resource areas, and defines 46 schemas. It is described by OpenAPI 3.0.1, at version 2026-09.

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

18 operations 10 paths 46 schemas 3 DELETE8 GET1 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2026-09
Base URL
https://api.hubapi.com
Authentication
API Key, OAuth 2.0, API Key, API Key
Resource Areas
4

Authentication & Security 4

HubSpot Automation Actions v4 API declares 4 security schemes for authenticating requests. An API key is passed in the query as hapikey (developer_hapikey). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 3 scopes. An API key is passed in the header as private-app (private_apps). An API key is passed in the header as private-app-legacy (private_apps_legacy).

Paths & Operations 18

Across 10 paths, the API surfaces 18 operations — 3 DELETE, 8 GET, 1 PATCH, 4 POST, 2 PUT. They span 4 resource areas: Definitions, Functions, Revisions, Callbacks. Each is listed below with its method, path, parameters, and response codes.

Definitions 7
GET
/automation/actions/2026-09/{appId}
Retrieve custom action definitions
get-/automation/actions/2026-09/{appId}_getPage 4 params → 200default
POST
/automation/actions/2026-09/{appId}
Create a new custom action definition
post-/automation/actions/2026-09/{appId}_create 1 param body → 201default
GET
/automation/actions/2026-09/{appId}/{definitionId}
Retrieve a custom action definition
get-/automation/actions/2026-09/{appId}/{definitionId}_getById 3 params → 200default
DELETE
/automation/actions/2026-09/{appId}/{definitionId}
Delete an action definition
delete-/automation/actions/2026-09/{appId}/{definitionId}_archive 2 params → 204default
PATCH
/automation/actions/2026-09/{appId}/{definitionId}
Update an existing action definition
patch-/automation/actions/2026-09/{appId}/{definitionId}_update 2 params body → 200default
GET
/automation/actions/2026-09/{appId}/{definitionId}/requires-object
Retrieve the object requirement status for a custom action definition.
get-/automation/actions/2026-09/{appId}/{definitionId}/requires-object_/automation/v4/actions/{appId}/{definitionId}/requires-object 2 params → 200default
POST
/automation/actions/2026-09/{appId}/{definitionId}/requires-object
Set the object requirement for a custom action definition.
post-/automation/actions/2026-09/{appId}/{definitionId}/requires-object_/automation/v4/actions/{appId}/{definitionId}/requires-object 2 params body → 204default
Functions 7
GET
/automation/actions/2026-09/{appId}/{definitionId}/functions
Retrieve functions for a given definition
get-/automation/actions/2026-09/{appId}/{definitionId}/functions_getPage 2 params → 200default
GET
/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}
Retrieve functions by a type for a given definition
get-/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}_getByFunctionType 3 params → 200default
PUT
/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}
Insert a function for a definition
put-/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}_createOrReplaceByFunctionType 3 params body → 200default
DELETE
/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}
Delete a function for a definition
delete-/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}_archiveByFunctionType 3 params → 204default
GET
/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}/{functionId}
Retrieve a function from a given definition
get-/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}/{functionId}_getById 4 params → 200default
PUT
/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}/{functionId}
Update a function for a definition
put-/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}/{functionId}_createOrReplace 4 params body → 200default
DELETE
/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}/{functionId}
Archive a function for a definition
delete-/automation/actions/2026-09/{appId}/{definitionId}/functions/{functionType}/{functionId}_archive 4 params → 204default
Revisions 2
GET
/automation/actions/2026-09/{appId}/{definitionId}/revisions
Retrieve revisions for a given definition
get-/automation/actions/2026-09/{appId}/{definitionId}/revisions_getPage 4 params → 200default
GET
/automation/actions/2026-09/{appId}/{definitionId}/revisions/{revisionId}
Retrieve a specific revision of a definition
get-/automation/actions/2026-09/{appId}/{definitionId}/revisions/{revisionId}_getById 3 params → 200default
Callbacks 2
POST
/automation/actions/callbacks/2026-09/complete
Complete a batch of callbacks
post-/automation/actions/callbacks/2026-09/complete_completeBatch body → 204default
POST
/automation/actions/callbacks/2026-09/{callbackId}/complete
Completes a callback
post-/automation/actions/callbacks/2026-09/{callbackId}/complete_complete 1 param body → 204default

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are PublicActionDefinition (13 properties), FieldTypeDefinition (13 properties), ChirpAiContextObject (11 properties), PublicActionDefinitionEgg (11 properties). Each schema is shown below with its type and property counts.

ActionExecutionIndexIdentifier
object
2 properties 2 required
AgentRequestContext
object
4 properties 3 required
ArrayFieldSchema
object
2 properties 2 required
BatchInputCallbackCompletionBatchRequest
object
1 property 1 required
BooleanFieldSchema
object
1 property 1 required
CallbackCompletionBatchRequest
object
5 properties 3 required
CallbackCompletionRequest
object
4 properties 2 required
ChirpAiContextObject
object
11 properties 6 required
CollectionResponsePublicActionDefinitionForwardPaging
object
2 properties 1 required
CollectionResponsePublicActionFunctionIdentifierNoPaging
object
1 property 1 required
CollectionResponsePublicActionRevisionForwardPaging
object
2 properties 1 required
ComplianceIds
object
6 properties 3 required
ContactId
object
3 properties 1 required
CopilotRequestContext
object
2 properties 1 required
DoubleFieldSchema
object
3 properties 1 required
Error
object
Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the…
7 properties 3 required
ErrorDetail
object
Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typic…
5 properties 1 required
FieldTypeDefinition
object
13 properties 6 required
ForwardPaging
object
Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
1 property
IntegerFieldSchema
object
3 properties 1 required
LongFieldSchema
object
3 properties 1 required
NextPage
object
Specifies the paging information needed to retrieve the next set of results in a paginated API response
2 properties 1 required
ObjectFieldSchema
object
2 properties 2 required
Option
object
A HubSpot property option
7 properties 7 required
OutputFieldDefinition
object
1 property 1 required
PublicActionDefinition
object
13 properties 8 required
PublicActionDefinitionEgg
object
11 properties 6 required
PublicActionDefinitionPatch
object
9 properties
PublicActionDefinitionRequiresObjectRequest
object
1 property 1 required
PublicActionDefinitionRequiresObjectResponse
object
1 property 1 required
PublicActionFunction
object
3 properties 2 required
PublicActionFunctionIdentifier
object
2 properties 1 required
PublicActionLabels
object
9 properties 1 required
PublicActionRevision
object
4 properties 4 required
PublicConditionalSingleFieldDependency
object
4 properties 4 required
PublicExecutionTranslationRule
object
2 properties 2 required
PublicFieldTypeDefinition
object
9 properties 3 required
PublicInputFieldDefinition
object
3 properties 2 required
PublicObjectRequestOptions
object
1 property 1 required
PublicOption
object
4 properties 2 required
PublicSingleFieldDependency
object
3 properties 3 required
StandaloneRequestContext
object
3 properties 2 required
StringFieldSchema
object
2 properties 1 required
TestRequestContext
object
1 property 1 required
UnknownFieldSchema
object
1 property 1 required
WorkflowsRequestContext
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-automation-actions-v4-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

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
HubSpot Workflows API
Where this information came from

This is an independent, third-party profile of HubSpot Automation Actions v4 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.