Skip to content

Commit 90a3fab

Browse files
byrrobyrro
authored
All Hubspot Starter MCP server docs (#570)
* all hubspot starter mcp servers docs * update design-system
1 parent b526952 commit 90a3fab

File tree

1,562 files changed

+73517
-674
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,562 files changed

+73517
-674
lines changed

‎app/en/mcp-servers/sales/hubspot-automation-api/page.mdx‎

Lines changed: 331 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,331 @@
1+
# HubspotAutomationApi
2+
3+
import StarterToolInfo from "@/app/_components/starter-tool-info";
4+
import ToolInfo from "@/app/_components/tool-info";
5+
import Badges from "@/app/_components/badges";
6+
import TabbedCodeBlock from "@/app/_components/tabbed-code-block";
7+
import TableOfContents from "@/app/_components/table-of-contents";
8+
import ToolFooter from "@/app/_components/tool-footer";
9+
import { Callout } from "nextra/components";
10+
11+
<ToolInfo
12+
description="Tools that enable LLMs to interact directly with the HubSpot Automation API."
13+
author="Arcade"
14+
authType="OAuth2"
15+
versions={["0.1.0"]}
16+
/>
17+
18+
<Badges repo="arcadeai/arcade_hubspot_automation_api" />
19+
20+
<StarterToolInfo toolkitName="HubspotAutomationApi" />
21+
22+
The HubspotAutomationApi MCP Server offers a comprehensive suite of tools for managing and automating workflows within HubSpot. Users can leverage these tools to:
23+
24+
- Complete and manage blocked action executions in automation workflows.
25+
- Fetch and retrieve details about email campaigns and workflows.
26+
- Check the enrollment status of contacts in sequences.
27+
- Enroll contacts into specific sequences for automated follow-ups.
28+
- Access user-specific sequences and their details.
29+
30+
This server streamlines the automation process, making it easier to handle marketing activities and user interactions within HubSpot.
31+
32+
## Available Tools
33+
34+
<TableOfContents
35+
headers={["Tool Name", "Description"]}
36+
data={[
37+
[
38+
"HubspotAutomationApi.CompleteActionExecution",
39+
"Complete a specific blocked action execution by ID.",
40+
],
41+
[
42+
"HubspotAutomationApi.CompleteBatchActionExecutions",
43+
"Complete a batch of blocked action executions.",
44+
],
45+
[
46+
"HubspotAutomationApi.FetchEmailCampaigns",
47+
"Fetch email campaigns from HubSpot Automation.",
48+
],
49+
[
50+
"HubspotAutomationApi.GetWorkflows",
51+
"Retrieve details of HubSpot workflows.",
52+
],
53+
[
54+
"HubspotAutomationApi.GetWorkflowIdMappings",
55+
"Retrieve HubSpot workflow ID mappings in batch.",
56+
],
57+
[
58+
"HubspotAutomationApi.CheckContactEnrollmentStatus",
59+
"Retrieve the sequence enrollment status of a contact by ID.",
60+
],
61+
[
62+
"HubspotAutomationApi.GetUserSequences",
63+
"Retrieve a list of sequences for a specific user.",
64+
],
65+
[
66+
"HubspotAutomationApi.EnrollContactInSequence",
67+
"Enroll a contact into a sequence with user ID and details.",
68+
],
69+
[
70+
"HubspotAutomationApi.GetSequenceDetails",
71+
"Retrieve details of a specific sequence by its ID.",
72+
],
73+
]}
74+
/>
75+
76+
<Callout>
77+
If you need to perform an action that's not listed here, you can [get in touch
78+
with us](mailto:contact@arcade.dev) to request a new tool, or [create your own
79+
tools](/home/build-tools/create-a-mcp-server).
80+
</Callout>
81+
82+
## HubspotAutomationApi.CompleteActionExecution
83+
84+
<br />
85+
<TabbedCodeBlock
86+
tabs={[
87+
{
88+
label: "Call the Tool Directly",
89+
content: {
90+
Python: [
91+
"/examples/integrations/mcp-servers/hubspot_automation_api/complete_action_execution_example_call_tool.py",
92+
],
93+
JavaScript: [
94+
"/examples/integrations/mcp-servers/hubspot_automation_api/complete_action_execution_example_call_tool.js",
95+
],
96+
},
97+
},
98+
]}
99+
/>
100+
101+
Complete a specific blocked action execution by ID.
102+
103+
**Parameters**
104+
105+
- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
106+
- **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'.
107+
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'
108+
109+
## HubspotAutomationApi.CompleteBatchActionExecutions
110+
111+
<br />
112+
<TabbedCodeBlock
113+
tabs={[
114+
{
115+
label: "Call the Tool Directly",
116+
content: {
117+
Python: [
118+
"/examples/integrations/mcp-servers/hubspot_automation_api/complete_batch_action_executions_example_call_tool.py",
119+
],
120+
JavaScript: [
121+
"/examples/integrations/mcp-servers/hubspot_automation_api/complete_batch_action_executions_example_call_tool.js",
122+
],
123+
},
124+
},
125+
]}
126+
/>
127+
128+
Complete a batch of blocked action executions.
129+
130+
**Parameters**
131+
132+
- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
133+
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'
134+
135+
## HubspotAutomationApi.FetchEmailCampaigns
136+
137+
<br />
138+
<TabbedCodeBlock
139+
tabs={[
140+
{
141+
label: "Call the Tool Directly",
142+
content: {
143+
Python: [
144+
"/examples/integrations/mcp-servers/hubspot_automation_api/fetch_email_campaigns_example_call_tool.py",
145+
],
146+
JavaScript: [
147+
"/examples/integrations/mcp-servers/hubspot_automation_api/fetch_email_campaigns_example_call_tool.js",
148+
],
149+
},
150+
},
151+
]}
152+
/>
153+
154+
Fetch email campaigns from HubSpot Automation.
155+
156+
**Parameters**
157+
158+
- **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.
159+
- **end_date_filter** (`string`, optional) A timestamp filter to get campaigns before a specific date (in YYYY-MM-DD format).
160+
- **max_results** (`integer`, optional) Specifies the maximum number of email campaign entries to retrieve. Should be an integer value.
161+
- **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.
162+
163+
## HubspotAutomationApi.GetWorkflows
164+
165+
<br />
166+
<TabbedCodeBlock
167+
tabs={[
168+
{
169+
label: "Call the Tool Directly",
170+
content: {
171+
Python: [
172+
"/examples/integrations/mcp-servers/hubspot_automation_api/get_workflows_example_call_tool.py",
173+
],
174+
JavaScript: [
175+
"/examples/integrations/mcp-servers/hubspot_automation_api/get_workflows_example_call_tool.js",
176+
],
177+
},
178+
},
179+
]}
180+
/>
181+
182+
Retrieve details of HubSpot workflows.
183+
184+
**Parameters**
185+
186+
- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
187+
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'
188+
189+
## HubspotAutomationApi.GetWorkflowIdMappings
190+
191+
<br />
192+
<TabbedCodeBlock
193+
tabs={[
194+
{
195+
label: "Call the Tool Directly",
196+
content: {
197+
Python: [
198+
"/examples/integrations/mcp-servers/hubspot_automation_api/get_workflow_id_mappings_example_call_tool.py",
199+
],
200+
JavaScript: [
201+
"/examples/integrations/mcp-servers/hubspot_automation_api/get_workflow_id_mappings_example_call_tool.js",
202+
],
203+
},
204+
},
205+
]}
206+
/>
207+
208+
Retrieve HubSpot workflow ID mappings in batch.
209+
210+
**Parameters**
211+
212+
- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
213+
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'
214+
215+
## HubspotAutomationApi.CheckContactEnrollmentStatus
216+
217+
<br />
218+
<TabbedCodeBlock
219+
tabs={[
220+
{
221+
label: "Call the Tool Directly",
222+
content: {
223+
Python: [
224+
"/examples/integrations/mcp-servers/hubspot_automation_api/check_contact_enrollment_status_example_call_tool.py",
225+
],
226+
JavaScript: [
227+
"/examples/integrations/mcp-servers/hubspot_automation_api/check_contact_enrollment_status_example_call_tool.js",
228+
],
229+
},
230+
},
231+
]}
232+
/>
233+
234+
Retrieve the sequence enrollment status of a contact by ID.
235+
236+
**Parameters**
237+
238+
- **contact_id** (`string`, required) The unique ID of the contact to check their sequence enrollment status.
239+
240+
## HubspotAutomationApi.GetUserSequences
241+
242+
<br />
243+
<TabbedCodeBlock
244+
tabs={[
245+
{
246+
label: "Call the Tool Directly",
247+
content: {
248+
Python: [
249+
"/examples/integrations/mcp-servers/hubspot_automation_api/get_user_sequences_example_call_tool.py",
250+
],
251+
JavaScript: [
252+
"/examples/integrations/mcp-servers/hubspot_automation_api/get_user_sequences_example_call_tool.js",
253+
],
254+
},
255+
},
256+
]}
257+
/>
258+
259+
Retrieve a list of sequences for a specific user.
260+
261+
**Parameters**
262+
263+
This tool does not take any parameters.
264+
265+
## HubspotAutomationApi.EnrollContactInSequence
266+
267+
<br />
268+
<TabbedCodeBlock
269+
tabs={[
270+
{
271+
label: "Call the Tool Directly",
272+
content: {
273+
Python: [
274+
"/examples/integrations/mcp-servers/hubspot_automation_api/enroll_contact_in_sequence_example_call_tool.py",
275+
],
276+
JavaScript: [
277+
"/examples/integrations/mcp-servers/hubspot_automation_api/enroll_contact_in_sequence_example_call_tool.js",
278+
],
279+
},
280+
},
281+
]}
282+
/>
283+
284+
Enroll a contact into a sequence with user ID and details.
285+
286+
**Parameters**
287+
288+
- **contact_id** (`string`, required) The unique identifier of the contact to be enrolled in the sequence.
289+
- **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.
290+
- **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.
291+
- **sender_alias_address** (`string`, optional) Email alias for the sender addressing the sequence. This is used instead of the default email address.
292+
293+
## HubspotAutomationApi.GetSequenceDetails
294+
295+
<br />
296+
<TabbedCodeBlock
297+
tabs={[
298+
{
299+
label: "Call the Tool Directly",
300+
content: {
301+
Python: [
302+
"/examples/integrations/mcp-servers/hubspot_automation_api/get_sequence_details_example_call_tool.py",
303+
],
304+
JavaScript: [
305+
"/examples/integrations/mcp-servers/hubspot_automation_api/get_sequence_details_example_call_tool.js",
306+
],
307+
},
308+
},
309+
]}
310+
/>
311+
312+
Retrieve details of a specific sequence by its ID.
313+
314+
**Parameters**
315+
316+
- **sequence_id** (`string`, required) The unique ID of the sequence to retrieve details for. This ID identifies which sequence's information will be returned.
317+
318+
## Reference
319+
320+
Below is a reference of enumerations used by some of the tools in the HubspotAutomationApi MCP Server:
321+
322+
### ToolMode
323+
324+
- **GET_REQUEST_SCHEMA**: `get_request_schema`
325+
- **EXECUTE**: `execute`
326+
327+
## Auth
328+
329+
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.
330+
331+
<ToolFooter pipPackageName="arcade_hubspot_automation_api" />

0 commit comments

Comments
 (0)