HubSpot Automation API
Tools that enable LLMs to interact directly with the HubSpot Automation API.
1.0.0
Arcade's HubSpot Automation API toolkit empowers developers to integrate LLMs with HubSpot's automation capabilities, facilitating seamless interaction with various automation workflows and sequences.
Capabilities
- Enroll contacts in sequences and fetch campaign details via automation tools.
- Retrieve sequence statuses and details efficiently using contact IDs.
- Manage batch actions and workflow ID mappings to optimize automation processes.
- Access user-specific sequences to track individual automated tasks.
OAuth Provider: Unknown Scopes: automation, automation.sequences.enrollments.write, automation.sequences.read
Secrets No secrets required for this toolkit.
Available tools(9)
| Tool name | Description | Secrets | |
|---|---|---|---|
Retrieve the sequence enrollment status of a contact by ID.
Use this tool to find out if a contact is enrolled in any sequences, using their contact ID to get the status information. | |||
Complete a specific blocked action execution by ID.
Call this tool to complete an action in an automation workflow that is currently blocked by its ID.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Complete a batch of blocked action executions.
Use this tool to mark a batch of previously blocked action executions as complete. Ideal for situations where action executions need to be finalized as part of an automated workflow.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Enroll a contact into a sequence with user ID and details.
This tool enrolls a specified contact into an automation sequence using the provided user ID and sequence details, facilitating automated follow-up actions. | |||
Fetch email campaigns from HubSpot Automation.
Use this tool to retrieve information about email campaigns managed within HubSpot's automation platform. It can be called to get an overview of current or past email marketing activities. | |||
Retrieve details of a specific sequence by its ID.
This tool retrieves information about a specific sequence using its ID. It should be called when you need details about a sequence within HubSpot Automation. | |||
Retrieve a list of sequences for a specific user.
Use this tool to get sequences associated with a user in HubSpot. Useful for tracking user-specific automated processes. | |||
Retrieve HubSpot workflow ID mappings in batch.
Call this tool to obtain mappings for HubSpot workflow IDs in batch. Useful for integrating workflows and managing automation processes.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Retrieve details of HubSpot workflows.
This tool allows you to fetch information about workflows in HubSpot. Use it when you need to access or manage workflow details for automation purposes.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
HubspotAutomationApi.CheckContactEnrollmentStatus
Retrieve the sequence enrollment status of a contact by ID. Use this tool to find out if a contact is enrolled in any sequences, using their contact ID to get the status information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | The unique ID of the contact to check their sequence enrollment status. |
Requirements
Output
json— Response from the API endpoint 'get-/automation/v4/sequences/enrollments/contact/{contactId}'.HubspotAutomationApi.CompleteActionExecution
Complete a specific blocked action execution by ID. Call this tool to complete an action in an automation workflow that is currently blocked by its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
action_execution_id | string | Optional | The unique identifier of the action execution to be completed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/automation/v4/actions/callbacks/{callbackId}/complete_complete'.HubspotAutomationApi.CompleteBatchActionExecutions
Complete a batch of blocked action executions. Use this tool to mark a batch of previously blocked action executions as complete. Ideal for situations where action executions need to be finalized as part of an automated workflow. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/automation/v4/actions/callbacks/complete_completeBatch'.HubspotAutomationApi.EnrollContactInSequence
Enroll a contact into a sequence with user ID and details. This tool enrolls a specified contact into an automation sequence using the provided user ID and sequence details, facilitating automated follow-up actions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | The unique identifier of the contact to be enrolled in the sequence. |
sender_email | string | Required | The email address of the sender enrolling the contact. This should be a valid email associated with the sender's HubSpot user account. |
sequence_identifier | string | Required | The unique identifier of the sequence to enroll the contact into. It should be a valid string matching the sequence available in the system. |
sender_alias_address | string | Optional | Email alias for the sender addressing the sequence. This is used instead of the default email address. |
Requirements
Output
json— Response from the API endpoint 'post-/automation/v4/sequences/enrollments'.HubspotAutomationApi.FetchEmailCampaigns
Fetch email campaigns from HubSpot Automation. Use this tool to retrieve information about email campaigns managed within HubSpot's automation platform. It can be called to get an overview of current or past email marketing activities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
email_campaign_flow_ids | array<string> | Optional | An array of flow IDs to specify which email campaigns to retrieve. Each ID should be a string. |
end_date_filter | string | Optional | A timestamp filter to get campaigns before a specific date (in YYYY-MM-DD format). |
max_results | integer | Optional | Specifies the maximum number of email campaign entries to retrieve. Should be an integer value. |
start_date | string | Optional | Specify the start date for fetching email campaigns. This should be in the format YYYY-MM-DD to filter results starting after this date. |
Requirements
Output
json— Response from the API endpoint 'get-/automation/v4/flows/email-campaigns'.HubspotAutomationApi.GetSequenceDetails
Retrieve details of a specific sequence by its ID. This tool retrieves information about a specific sequence using its ID. It should be called when you need details about a sequence within HubSpot Automation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
sequence_id | string | Required | The unique ID of the sequence to retrieve details for. This ID identifies which sequence's information will be returned. |
Requirements
Output
json— Response from the API endpoint 'get-/automation/v4/sequences/{sequenceId}'.HubspotAutomationApi.GetUserSequences
Retrieve a list of sequences for a specific user. Use this tool to get sequences associated with a user in HubSpot. Useful for tracking user-specific automated processes.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/automation/v4/sequences/'.HubspotAutomationApi.GetWorkflowIdMappings
Retrieve HubSpot workflow ID mappings in batch. Call this tool to obtain mappings for HubSpot workflow IDs in batch. Useful for integrating workflows and managing automation processes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/automation/v4/workflow-id-mappings/batch/read'.HubspotAutomationApi.GetWorkflows
Retrieve details of HubSpot workflows. This tool allows you to fetch information about workflows in HubSpot. Use it when you need to access or manage workflow details for automation purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/automation/v4/flows/batch/read'.