Hubspot
Description: Enable agents to interact with Hubspot
Author: Arcade
Auth: User authorization
The Hubspot toolkit offers pre-built tools for interacting with HubSpot CRM. Use these tools to automate CRM updates, log interactions, link records, and query HubSpot data for workflows and agents.
Available Tools
Tool Name | Description |
---|---|
Hubspot.GetAllUsers | Get all users/owners in the HubSpot portal. |
Hubspot.GetUserById | Get detailed information about a specific user/owner by their ID. |
Hubspot.WhoAmI | Get current user information from HubSpot. |
Hubspot.ToolkitEnviromentGuidance | Get guidance and considerations for using the HubSpot toolkit effectively. |
Hubspot.CreateNoteActivity | Create a note engagement activity with required owner and associations. |
Hubspot.CreateCallActivity | Create a call engagement activity with required owner and associations. |
Hubspot.CreateEmailActivity | Create a logged email engagement activity with essential fields including email headers. |
Hubspot.CreateMeetingActivity | Create a meeting with essential fields including separate date and time. |
Hubspot.CreateCommunicationActivity | Create a communication activity for logging communications that are not done via |
Hubspot.AssociateActivityToDeal | Associate a single activity object to a deal using HubSpot standard association type. |
Hubspot.GetContactDataByKeywords | Retrieve contact data with associated companies, deals, calls, emails, |
Hubspot.CreateContact | Create a contact associated with a company. |
Hubspot.ListContacts | List contacts with optional filtering by company ID or deal ID, with pagination support. |
Hubspot.GetDealDataByKeywords | Retrieve deal data with associated contacts, companies, calls, emails, |
Hubspot.CreateDeal | Create a new deal in HubSpot. |
Hubspot.UpdateDealCloseDate | Update the expected close date of an existing deal in HubSpot. |
Hubspot.UpdateDealStage | Updates a deal's stage, validating against the current pipeline if provided |
Hubspot.GetDealById | Retrieve a specific deal by its ID from HubSpot. |
Hubspot.AssociateContactToDeal | Associate a contact with an existing deal in HubSpot. |
Hubspot.ListDeals | List deals with optional filtering by contact ID or company ID, with pagination support. |
Hubspot.GetNoteDataByKeywords | Search for note activities by search terms in NOTE object properties. |
Hubspot.GetCallDataByKeywords | Search for call activities by search terms in CALL object properties. |
Hubspot.GetEmailDataByKeywords | Search for email activities by search terms in EMAIL object properties. |
Hubspot.GetMeetingDataByKeywords | Search for meeting activities by search terms in MEETING object properties. |
Hubspot.GetTaskDataByKeywords | Search for task activities by search terms in TASK object properties. |
Hubspot.GetCommunicationDataByKeywords | Search for communication activities by search terms in COMMUNICATION object properties. |
Hubspot.GetCompanyDataByKeywords | Retrieve company data with associated contacts, deals, calls, emails, |
Hubspot.CreateCompany | Create a new company in HubSpot. |
Hubspot.ListCompanies | List companies with pagination support. |
Hubspot.GetAvailableIndustryTypes | Get all available industry types for HubSpot companies. |
Hubspot.GetDealPipelines | List HubSpot deal pipelines with their stages, optionally filtered by a search string. |
Hubspot.GetDealPipelineStages | List stages for a specific HubSpot deal pipeline. |
If you need to perform an action that’s not listed here, you can get in touch with us to request a new tool, or create your own tools.
Hubspot.GetAllUsers
Get all users/owners in the HubSpot portal.
Parameters
This tool does not take any parameters.
Hubspot.GetUserById
Get detailed information about a specific user/owner by their ID.
Parameters
- owner_id (
integer
, required) The HubSpot owner/user ID to retrieve
Hubspot.WhoAmI
Get current user information from HubSpot.
Parameters
This tool does not take any parameters.
Hubspot.ToolkitEnviromentGuidance
Get guidance and considerations for using the HubSpot toolkit effectively.
Parameters
This tool does not take any parameters.
Hubspot.CreateNoteActivity
Create a note engagement activity with required owner and associations.
Parameters
- body (
string
, required) The note content/body. - when_occurred (
string
, required) When the note was created (ISO date format: YYYY-MM-DDTHH:MM:SS). - associate_to_contact_id (
integer
, optional) Contact ID to associate this note with. - associate_to_company_id (
integer
, optional) Company ID to associate this note with. - associate_to_deal_id (
integer
, optional) Deal ID to associate this note with.
Hubspot.CreateCallActivity
Create a call engagement activity with required owner and associations.
Parameters
- title (
string
, required) Short title for the call. - when_occurred (
string
, required) When the call occurred (ISO date format: YYYY-MM-DDTHH:MM:SS). - direction (
Enum
HubspotCallDirection, optional) Call direction (INBOUND or OUTBOUND). - summary (
string
, optional) Short summary/notes of the call. - duration (
integer
, optional) Call duration in seconds. - to_number (
string
, optional) Phone number called to. - from_number (
string
, optional) Phone number called from. - associate_to_contact_id (
integer
, optional) Contact ID to associate this call with. - associate_to_company_id (
integer
, optional) Company ID to associate this call with. - associate_to_deal_id (
integer
, optional) Deal ID to associate this call with.
Hubspot.CreateEmailActivity
Create a logged email engagement activity with essential fields including email headers.
Parameters
- subject (
string
, required) Email subject. - when_occurred (
string
, required) When the email occurred (ISO date format: YYYY-MM-DDTHH:MM:SS). - from_email (
string
, required) Sender email address. - to_email (
string
, required) Primary recipient email address. - body_text (
string
, optional) Email body in plain text. - body_html (
string
, optional) Email body in HTML format. - from_first_name (
string
, optional) Sender first name. - from_last_name (
string
, optional) Sender last name. - to_first_name (
string
, optional) Primary recipient first name. - to_last_name (
string
, optional) Primary recipient last name. - cc_emails (
array[string]
, optional) CC recipient email addresses. - bcc_emails (
array[string]
, optional) BCC recipient email addresses. - direction (
Enum
HubspotEmailDirection, optional) Direction the email was sent (EMAIL, INCOMING_EMAIL, FORWARDED_EMAIL). - status (
Enum
HubspotEmailStatus, optional) Email status indicating the state of the email. - associate_to_contact_id (
integer
, optional) Contact ID to associate this email with. - associate_to_company_id (
integer
, optional) Company ID to associate this email with. - associate_to_deal_id (
integer
, optional) Deal ID to associate this email with.
Hubspot.CreateMeetingActivity
Create a meeting with essential fields including separate date and time.
Parameters
- title (
string
, required) Meeting title. - start_date (
string
, required) Start date (YYYY-MM-DD format). - start_time (
string
, required) Start time (HH:MM or HH:MM:SS format). - duration (
string
, optional) Meeting duration in HH:MM format (e.g., 1:30 for 1 hour 30 minutes). - location (
string
, optional) Meeting location. - outcome (
Enum
HubspotMeetingOutcome, optional) Meeting outcome. - associate_to_contact_id (
integer
, optional) Contact ID to associate this meeting with. - associate_to_company_id (
integer
, optional) Company ID to associate this meeting with. - associate_to_deal_id (
integer
, optional) Deal ID to associate this meeting with.
Hubspot.CreateCommunicationActivity
Create a communication activity for logging communications that are not done via
Parameters
- channel (
Enum
HubspotCommunicationChannel, required) Communication channel type. - when_occurred (
string
, required) When the communication occurred (ISO date format: YYYY-MM-DDTHH:MM:SS). - body_text (
string
, optional) Full message content. - associate_to_contact_id (
integer
, optional) Contact ID to associate this communication with. - associate_to_company_id (
integer
, optional) Company ID to associate this communication with. - associate_to_deal_id (
integer
, optional) Deal ID to associate this communication with.
Hubspot.AssociateActivityToDeal
Associate a single activity object to a deal using HubSpot standard association type.
Parameters
- activity_type (
Enum
HubspotActivityType, required) Engagement activity type. - activity_id (
integer
, required) The activity object ID - deal_id (
integer
, required) The deal ID to associate to
Hubspot.GetContactDataByKeywords
Retrieve contact data with associated companies, deals, calls, emails,
Parameters
- keywords (
string
, required) The keywords to search for contacts. It will match against the contact’s first and last name, email addresses, phone numbers, and company name. - limit (
integer
, optional) The maximum number of contacts to return. Defaults to 10. Max is 100. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.CreateContact
Create a contact associated with a company.
Parameters
- company_id (
integer
, required) The ID of the company to create the contact for. - first_name (
string
, required) The first name of the contact. - last_name (
string
, optional) The last name of the contact. - email (
string
, optional) The email address of the contact. - phone (
string
, optional) The phone number of the contact. - mobile_phone (
string
, optional) The mobile phone number of the contact. - job_title (
string
, optional) The job title of the contact.
Hubspot.ListContacts
List contacts with optional filtering by company ID or deal ID, with pagination support.
Parameters
- limit (
integer
, optional) The maximum number of contacts to return. Defaults to 10. Max is 50. - company_id (
integer
, optional) Filter contacts by company ID. Defaults to None (no filtering). - deal_id (
integer
, optional) Filter contacts by deal ID. Defaults to None (no filtering). - sort_order (
Enum
HubspotSortOrder, optional) Sort order for results. Defaults to LATEST_MODIFIED. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.GetDealDataByKeywords
Retrieve deal data with associated contacts, companies, calls, emails,
Parameters
- keywords (
string
, required) The keywords to search for deals. It will match against the deal name and description. - limit (
integer
, optional) The maximum number of deals to return. Defaults to 10. Max is 10. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.CreateDeal
Create a new deal in HubSpot.
Parameters
- deal_name (
string
, required) The deal name (required) - deal_amount (
number
, optional) The deal amount/value - deal_stage (
string
, optional) The deal stage - deal_type (
Enum
HubspotDealType, optional) The deal type. - expected_close_date (
string
, optional) Expected close date in YYYY-MM-DD format - pipeline_id (
string
, optional) Pipeline id. Use ‘default’ for default pipeline or pass a pipeline id (integer) - deal_owner (
string
, optional) The deal owner user ID - priority_level (
Enum
HubspotDealPriority, optional) Priority level. - deal_description (
string
, optional) The deal description
Hubspot.UpdateDealCloseDate
Update the expected close date of an existing deal in HubSpot.
Parameters
- deal_id (
integer
, required) The ID of the deal to update - expected_close_date (
string
, required) New expected close date in YYYY-MM-DD format
Hubspot.UpdateDealStage
Updates a deal’s stage, validating against the current pipeline if provided
Parameters
- deal_id (
integer
, required) The ID of the deal to update - deal_stage (
string
, required) New deal stage ID - current_pipeline_id (
string
, optional) Current pipeline id for this deal, if already known (skips fetching the deal) - allow_pipeline_change (
boolean
, optional) If true, allows changing the deal’s pipeline when the stage belongs to another pipeline
Hubspot.GetDealById
Retrieve a specific deal by its ID from HubSpot.
Parameters
- deal_id (
integer
, required) The ID of the deal to retrieve
Hubspot.AssociateContactToDeal
Associate a contact with an existing deal in HubSpot.
Parameters
- deal_id (
integer
, required) The ID of the deal to associate the contact with - contact_id (
integer
, required) The ID of the contact to associate with the deal
Hubspot.ListDeals
List deals with optional filtering by contact ID or company ID, with pagination support.
Parameters
- limit (
integer
, optional) The maximum number of deals to return. Defaults to 10. Max is 50. - contact_id (
integer
, optional) Filter deals by contact ID. Defaults to None (no filtering). - company_id (
integer
, optional) Filter deals by company ID. Defaults to None (no filtering). - sort_order (
Enum
HubspotSortOrder, optional) Sort order for results. Defaults to LATEST_MODIFIED. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.GetNoteDataByKeywords
Search for note activities by search terms in NOTE object properties.
Parameters
- search_terms (
string
, required) Search phrase or terms to find in NOTE properties. - limit (
integer
, optional) The maximum number of notes to return. Defaults to 10. Max is 50. - truncate_big_strings (
boolean
, optional) Whether to truncate string properties longer than 100 characters. Defaults to False. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.GetCallDataByKeywords
Search for call activities by search terms in CALL object properties.
Parameters
- search_terms (
string
, required) Search phrase or terms to find in CALL properties. - limit (
integer
, optional) The maximum number of calls to return. Defaults to 10. Max is 50. - truncate_big_strings (
boolean
, optional) Whether to truncate string properties longer than 100 characters. Defaults to False. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.GetEmailDataByKeywords
Search for email activities by search terms in EMAIL object properties.
Parameters
- search_terms (
string
, required) Search phrase or terms to find in EMAIL properties. - limit (
integer
, optional) The maximum number of emails to return. Defaults to 10. Max is 50. - truncate_big_strings (
boolean
, optional) Whether to truncate string properties longer than 100 characters. Defaults to False. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.GetMeetingDataByKeywords
Search for meeting activities by search terms in MEETING object properties.
Parameters
- search_terms (
string
, required) Search phrase or terms to find in MEETING properties. - limit (
integer
, optional) The maximum number of meetings to return. Defaults to 10. Max is 50. - truncate_big_strings (
boolean
, optional) Whether to truncate string properties longer than 100 characters. Defaults to False. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.GetTaskDataByKeywords
Search for task activities by search terms in TASK object properties.
Parameters
- search_terms (
string
, required) Search phrase or terms to find in TASK properties. - limit (
integer
, optional) The maximum number of tasks to return. Defaults to 10. Max is 50. - truncate_big_strings (
boolean
, optional) Whether to truncate string properties longer than 100 characters. Defaults to False. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.GetCommunicationDataByKeywords
Search for communication activities by search terms in COMMUNICATION object properties.
Parameters
- search_terms (
string
, required) Search phrase or terms to find in COMMUNICATION properties. - limit (
integer
, optional) The maximum number of communications to return. Defaults to 10. Max is 50. - truncate_big_strings (
boolean
, optional) Whether to truncate string properties longer than 100 characters. Defaults to False. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.GetCompanyDataByKeywords
Retrieve company data with associated contacts, deals, calls, emails,
Parameters
- keywords (
string
, required) The keywords to search for companies. It will match against the company name, phone, and website. - limit (
integer
, optional) The maximum number of companies to return. Defaults to 10. Max is 10. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.CreateCompany
Create a new company in HubSpot.
Parameters
- company_name (
string
, required) The company name (required) - web_domain (
string
, optional) The company web domain (e.g., example.com) - industry_type (
string
, optional) The company industry type (case-insensitive). - company_city (
string
, optional) The company city location - company_state (
string
, optional) The company state or province - company_country (
string
, optional) The company country - phone_number (
string
, optional) The company main phone number - website_url (
string
, optional) The company website URL
Hubspot.ListCompanies
List companies with pagination support.
Parameters
- limit (
integer
, optional) The maximum number of companies to return. Defaults to 10. Max is 50. - sort_order (
Enum
HubspotSortOrder, optional) Sort order for results. Defaults to LATEST_MODIFIED. - next_page_token (
string
, optional) The token to get the next page of results. Defaults to None (returns first page of results)
Hubspot.GetAvailableIndustryTypes
Get all available industry types for HubSpot companies.
Parameters
This tool does not take any parameters.
Hubspot.GetDealPipelines
List HubSpot deal pipelines with their stages, optionally filtered by a search string.
Parameters
- search (
string
, optional) Optional case-insensitive search string to filter pipelines by id or label
Hubspot.GetDealPipelineStages
List stages for a specific HubSpot deal pipeline.
Parameters
- pipeline_id (
string
, required) The pipeline id (e.g., ‘default’ or a pipeline GUID)
Auth
The Arcade Cloud Platform offers a default Hubspot auth provider. If you use it, there’s nothing to configure. Your users will see Arcade
as the name of the application requesting permission.