Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
331 changes: 331 additions & 0 deletions app/en/mcp-servers/sales/hubspot-automation-api/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,331 @@
# HubspotAutomationApi

import StarterToolInfo from "@/app/_components/starter-tool-info";
import ToolInfo from "@/app/_components/tool-info";
import Badges from "@/app/_components/badges";
import TabbedCodeBlock from "@/app/_components/tabbed-code-block";
import TableOfContents from "@/app/_components/table-of-contents";
import ToolFooter from "@/app/_components/tool-footer";
import { Callout } from "nextra/components";

<ToolInfo
description="Tools that enable LLMs to interact directly with the HubSpot Automation API."
author="Arcade"
authType="OAuth2"
versions={["0.1.0"]}
/>

<Badges repo="arcadeai/arcade_hubspot_automation_api" />

<StarterToolInfo toolkitName="HubspotAutomationApi" />

The HubspotAutomationApi MCP Server offers a comprehensive suite of tools for managing and automating workflows within HubSpot. Users can leverage these tools to:

- Complete and manage blocked action executions in automation workflows.
- Fetch and retrieve details about email campaigns and workflows.
- Check the enrollment status of contacts in sequences.
- Enroll contacts into specific sequences for automated follow-ups.
- Access user-specific sequences and their details.

This server streamlines the automation process, making it easier to handle marketing activities and user interactions within HubSpot.

## Available Tools

<TableOfContents
headers={["Tool Name", "Description"]}
data={[
[
"HubspotAutomationApi.CompleteActionExecution",
"Complete a specific blocked action execution by ID.",
],
[
"HubspotAutomationApi.CompleteBatchActionExecutions",
"Complete a batch of blocked action executions.",
],
[
"HubspotAutomationApi.FetchEmailCampaigns",
"Fetch email campaigns from HubSpot Automation.",
],
[
"HubspotAutomationApi.GetWorkflows",
"Retrieve details of HubSpot workflows.",
],
[
"HubspotAutomationApi.GetWorkflowIdMappings",
"Retrieve HubSpot workflow ID mappings in batch.",
],
[
"HubspotAutomationApi.CheckContactEnrollmentStatus",
"Retrieve the sequence enrollment status of a contact by ID.",
],
[
"HubspotAutomationApi.GetUserSequences",
"Retrieve a list of sequences for a specific user.",
],
[
"HubspotAutomationApi.EnrollContactInSequence",
"Enroll a contact into a sequence with user ID and details.",
],
[
"HubspotAutomationApi.GetSequenceDetails",
"Retrieve details of a specific sequence by its ID.",
],
]}
/>

<Callout>
If you need to perform an action that's not listed here, you can [get in touch
with us](mailto:contact@arcade.dev) to request a new tool, or [create your own
tools](/home/build-tools/create-a-mcp-server).
</Callout>

## HubspotAutomationApi.CompleteActionExecution

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/mcp-servers/hubspot_automation_api/complete_action_execution_example_call_tool.py",
],
JavaScript: [
"/examples/integrations/mcp-servers/hubspot_automation_api/complete_action_execution_example_call_tool.js",
],
},
},
]}
/>

Complete a specific blocked action execution by ID.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **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'

## HubspotAutomationApi.CompleteBatchActionExecutions

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/mcp-servers/hubspot_automation_api/complete_batch_action_executions_example_call_tool.py",
],
JavaScript: [
"/examples/integrations/mcp-servers/hubspot_automation_api/complete_batch_action_executions_example_call_tool.js",
],
},
},
]}
/>

Complete a batch of blocked action executions.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

## HubspotAutomationApi.FetchEmailCampaigns

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/mcp-servers/hubspot_automation_api/fetch_email_campaigns_example_call_tool.py",
],
JavaScript: [
"/examples/integrations/mcp-servers/hubspot_automation_api/fetch_email_campaigns_example_call_tool.js",
],
},
},
]}
/>

Fetch email campaigns from HubSpot Automation.

**Parameters**

- **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.

## HubspotAutomationApi.GetWorkflows

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/mcp-servers/hubspot_automation_api/get_workflows_example_call_tool.py",
],
JavaScript: [
"/examples/integrations/mcp-servers/hubspot_automation_api/get_workflows_example_call_tool.js",
],
},
},
]}
/>

Retrieve details of HubSpot workflows.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

## HubspotAutomationApi.GetWorkflowIdMappings

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/mcp-servers/hubspot_automation_api/get_workflow_id_mappings_example_call_tool.py",
],
JavaScript: [
"/examples/integrations/mcp-servers/hubspot_automation_api/get_workflow_id_mappings_example_call_tool.js",
],
},
},
]}
/>

Retrieve HubSpot workflow ID mappings in batch.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

## HubspotAutomationApi.CheckContactEnrollmentStatus

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/mcp-servers/hubspot_automation_api/check_contact_enrollment_status_example_call_tool.py",
],
JavaScript: [
"/examples/integrations/mcp-servers/hubspot_automation_api/check_contact_enrollment_status_example_call_tool.js",
],
},
},
]}
/>

Retrieve the sequence enrollment status of a contact by ID.

**Parameters**

- **contact_id** (`string`, required) The unique ID of the contact to check their sequence enrollment status.

## HubspotAutomationApi.GetUserSequences

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/mcp-servers/hubspot_automation_api/get_user_sequences_example_call_tool.py",
],
JavaScript: [
"/examples/integrations/mcp-servers/hubspot_automation_api/get_user_sequences_example_call_tool.js",
],
},
},
]}
/>

Retrieve a list of sequences for a specific user.

**Parameters**

This tool does not take any parameters.

## HubspotAutomationApi.EnrollContactInSequence

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/mcp-servers/hubspot_automation_api/enroll_contact_in_sequence_example_call_tool.py",
],
JavaScript: [
"/examples/integrations/mcp-servers/hubspot_automation_api/enroll_contact_in_sequence_example_call_tool.js",
],
},
},
]}
/>

Enroll a contact into a sequence with user ID and details.

**Parameters**

- **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.

## HubspotAutomationApi.GetSequenceDetails

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/mcp-servers/hubspot_automation_api/get_sequence_details_example_call_tool.py",
],
JavaScript: [
"/examples/integrations/mcp-servers/hubspot_automation_api/get_sequence_details_example_call_tool.js",
],
},
},
]}
/>

Retrieve details of a specific sequence by its ID.

**Parameters**

- **sequence_id** (`string`, required) The unique ID of the sequence to retrieve details for. This ID identifies which sequence's information will be returned.

## Reference

Below is a reference of enumerations used by some of the tools in the HubspotAutomationApi MCP Server:

### ToolMode

- **GET_REQUEST_SCHEMA**: `get_request_schema`
- **EXECUTE**: `execute`

## Auth

The HubspotAutomationApi MCP Server uses the Auth Provider with id `arcade-hubspot` to connect to users' HubspotAutomationApi accounts. In order to use the MCP Server, you will need to configure the `arcade-hubspot` auth provider.

<ToolFooter pipPackageName="arcade_hubspot_automation_api" />
Loading