HubSpot is a comprehensive CRM platform that provides a full suite of marketing, sales, and customer service tools to help businesses grow. With powerful automation capabilities and an extensive API, HubSpot serves businesses of all sizes across industries.
With the HubSpot integration in SteelEngine, you can:
- Manage contacts: List, get, create, update, and search contacts in your CRM
- Manage companies: List, get, create, update, and search company records
- Track deals: List deals in your sales pipeline
- Access users: Retrieve user information from your HubSpot account
In SteelEngine, the HubSpot integration enables your agents to interact with your CRM data as part of automated workflows. Agents can qualify leads, enrich contact records, track deals, and synchronize data across your tech stack—enabling intelligent sales and marketing automation.
Integrate HubSpot into your workflow. Manage contacts, companies, deals, tickets, and other CRM objects with powerful automation capabilities. Use the dedicated trigger block to start a workflow from provider events.
Retrieve all users from HubSpot account
| Parameter | Type | Required | Description |
|---|
limit | string | No | Number of results to return (default: 100, max: 100) |
after | string | No | Pagination cursor for next page of results (from previous response) |
| Parameter | Type | Description |
|---|
users | array | Array of HubSpot user objects |
↳ id | string | User ID |
↳ email | string | User email address |
↳ roleId | string | User role ID |
↳ primaryTeamId | string | Primary team ID |
↳ secondaryTeamIds | array | Secondary team IDs |
↳ superAdmin | boolean | Whether user is a super admin |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
totalItems | number | Total number of users returned |
success | boolean | Operation success status |
Retrieve all contacts from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 100) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "email,firstname,lastname,phone") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "companies,deals") |
| Parameter | Type | Description |
|---|
contacts | array | Array of HubSpot contact records |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single contact by ID or email from HubSpot
| Parameter | Type | Required | Description |
|---|
contactId | string | Yes | The HubSpot contact ID (numeric string) or email address to retrieve |
idProperty | string | No | Property to use as unique identifier (e.g., "email"). If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "email,firstname,lastname,phone") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "companies,deals") |
| Parameter | Type | Description |
|---|
contact | object | HubSpot contact record |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
contactId | string | The retrieved contact ID |
success | boolean | Operation success status |
Create a new contact in HubSpot. Requires at least one of: email, firstname, or lastname
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Contact properties as JSON object. Must include at least one of: email, firstname, or lastname (e.g., {"email": "john@example.com", "firstname": "John", "lastname": "Doe"}) |
associations | array | No | Array of associations to create with the contact as JSON. Each object should have "to.id" (company/deal ID) and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
contact | object | HubSpot contact record |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
contactId | string | The created contact ID |
success | boolean | Operation success status |
Update an existing contact in HubSpot by ID or email
| Parameter | Type | Required | Description |
|---|
contactId | string | Yes | The HubSpot contact ID (numeric string) or email of the contact to update |
idProperty | string | No | Property to use as unique identifier (e.g., "email"). If not specified, uses record ID |
properties | object | Yes | Contact properties to update as JSON object (e.g., {"firstname": "John", "phone": "+1234567890"}) |
| Parameter | Type | Description |
|---|
contact | object | HubSpot contact record |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
contactId | string | The updated contact ID |
success | boolean | Operation success status |
Search for contacts in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against contact name, email, and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["email", "firstname", "lastname", "phone"]) |
limit | number | No | Maximum number of results to return (max 100) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
contacts | array | Array of HubSpot contact records |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching contacts |
success | boolean | Operation success status |
Retrieve all companies from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 100) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "name,domain,industry") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,deals") |
| Parameter | Type | Description |
|---|
companies | array | Array of HubSpot company records |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single company by ID or domain from HubSpot
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | The HubSpot company ID (numeric string) or domain to retrieve |
idProperty | string | No | Property to use as unique identifier (e.g., "domain"). If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "name,domain,industry") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,deals") |
| Parameter | Type | Description |
|---|
company | object | HubSpot company record |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
companyId | string | The retrieved company ID |
success | boolean | Operation success status |
Create a new company in HubSpot
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Company properties as JSON object (e.g., {"name": "Acme Inc", "domain": "acme.com", "industry": "Technology"}) |
associations | array | No | Array of associations to create with the company as JSON (each with "to.id" and "types" containing "associationCategory" and "associationTypeId") |
| Parameter | Type | Description |
|---|
company | object | HubSpot company record |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
companyId | string | The created company ID |
success | boolean | Operation success status |
Update an existing company in HubSpot by ID or domain
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | The HubSpot company ID (numeric string) or domain of the company to update |
idProperty | string | No | Property to use as unique identifier (e.g., "domain"). If not specified, uses record ID |
properties | object | Yes | Company properties to update as JSON object (e.g., {"name": "New Name", "industry": "Finance"}) |
| Parameter | Type | Description |
|---|
company | object | HubSpot company record |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
companyId | string | The updated company ID |
success | boolean | Operation success status |
Search for companies in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against company name, domain, and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["name", "domain", "industry"]) |
limit | number | No | Maximum number of results to return (max 100) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
companies | array | Array of HubSpot company records |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching companies |
success | boolean | Operation success status |
Retrieve all deals from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "dealname,amount,dealstage") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
deals | array | Array of HubSpot deal records |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single deal by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
dealId | string | Yes | The HubSpot deal ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "dealname,amount,dealstage") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
deal | object | HubSpot deal record |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
dealId | string | The retrieved deal ID |
success | boolean | Operation success status |
Create a new deal in HubSpot. Requires at least a dealname property
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Deal properties as JSON object. Must include dealname (e.g., {"dealname": "New Deal", "amount": "5000", "dealstage": "appointmentscheduled"}) |
associations | array | No | Array of associations to create with the deal as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
deal | object | HubSpot deal record |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
dealId | string | The created deal ID |
success | boolean | Operation success status |
Update an existing deal in HubSpot by ID
| Parameter | Type | Required | Description |
|---|
dealId | string | Yes | The HubSpot deal ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | object | Yes | Deal properties to update as JSON object (e.g., {"amount": "10000", "dealstage": "closedwon"}) |
| Parameter | Type | Description |
|---|
deal | object | HubSpot deal record |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
dealId | string | The updated deal ID |
success | boolean | Operation success status |
Search for deals in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "NEQ", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against deal name and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["dealname", "amount", "dealstage"]) |
limit | number | No | Maximum number of results to return (max 200) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
deals | array | Array of HubSpot deal records |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching deals |
success | boolean | Operation success status |
Retrieve all tickets from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "subject,content,hs_ticket_priority") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
tickets | array | Array of HubSpot ticket records |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single ticket by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
ticketId | string | Yes | The HubSpot ticket ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "subject,content,hs_ticket_priority") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
ticket | object | HubSpot ticket record |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
ticketId | string | The retrieved ticket ID |
success | boolean | Operation success status |
Create a new ticket in HubSpot. Requires subject and hs_pipeline_stage properties
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Ticket properties as JSON object. Must include subject and hs_pipeline_stage (e.g., {"subject": "Support request", "hs_pipeline_stage": "1", "hs_ticket_priority": "HIGH"}) |
associations | array | No | Array of associations to create with the ticket as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
ticket | object | HubSpot ticket record |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
ticketId | string | The created ticket ID |
success | boolean | Operation success status |
Update an existing ticket in HubSpot by ID
| Parameter | Type | Required | Description |
|---|
ticketId | string | Yes | The HubSpot ticket ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | object | Yes | Ticket properties to update as JSON object (e.g., {"subject": "Updated subject", "hs_ticket_priority": "HIGH"}) |
| Parameter | Type | Description |
|---|
ticket | object | HubSpot ticket record |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
ticketId | string | The updated ticket ID |
success | boolean | Operation success status |
Search for tickets in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "NEQ", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against ticket subject and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["subject", "content", "hs_ticket_priority"]) |
limit | number | No | Maximum number of results to return (max 200) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
tickets | array | Array of HubSpot ticket records |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching tickets |
success | boolean | Operation success status |
Retrieve all line items from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "name,quantity,price,amount") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,quotes") |
| Parameter | Type | Description |
|---|
lineItems | array | Array of HubSpot line item records |
↳ name | string | Line item name |
↳ description | string | Full description of the product |
↳ hs_sku | string | Unique product identifier (SKU) |
↳ quantity | string | Number of units included |
↳ price | string | Unit price |
↳ amount | string | Total cost (quantity * unit price) |
↳ hs_line_item_currency_code | string | Currency code |
↳ recurringbillingfrequency | string | Recurring billing frequency |
↳ hs_recurring_billing_start_date | string | Recurring billing start date |
↳ hs_recurring_billing_end_date | string | Recurring billing end date |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single line item by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
lineItemId | string | Yes | The HubSpot line item ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "name,quantity,price,amount") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,quotes") |
| Parameter | Type | Description |
|---|
lineItem | object | HubSpot line item record |
↳ name | string | Line item name |
↳ description | string | Full description of the product |
↳ hs_sku | string | Unique product identifier (SKU) |
↳ quantity | string | Number of units included |
↳ price | string | Unit price |
↳ amount | string | Total cost (quantity * unit price) |
↳ hs_line_item_currency_code | string | Currency code |
↳ recurringbillingfrequency | string | Recurring billing frequency |
↳ hs_recurring_billing_start_date | string | Recurring billing start date |
↳ hs_recurring_billing_end_date | string | Recurring billing end date |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
lineItemId | string | The retrieved line item ID |
success | boolean | Operation success status |
Create a new line item in HubSpot. Requires at least a name property
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Line item properties as JSON object (e.g., {"name": "Product A", "quantity": "2", "price": "50.00", "hs_sku": "SKU-001"}) |
associations | array | No | Array of associations to create with the line item as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
lineItem | object | HubSpot line item record |
↳ name | string | Line item name |
↳ description | string | Full description of the product |
↳ hs_sku | string | Unique product identifier (SKU) |
↳ quantity | string | Number of units included |
↳ price | string | Unit price |
↳ amount | string | Total cost (quantity * unit price) |
↳ hs_line_item_currency_code | string | Currency code |
↳ recurringbillingfrequency | string | Recurring billing frequency |
↳ hs_recurring_billing_start_date | string | Recurring billing start date |
↳ hs_recurring_billing_end_date | string | Recurring billing end date |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
lineItemId | string | The created line item ID |
success | boolean | Operation success status |
Update an existing line item in HubSpot by ID
| Parameter | Type | Required | Description |
|---|
lineItemId | string | Yes | The HubSpot line item ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | object | Yes | Line item properties to update as JSON object (e.g., {"quantity": "5", "price": "25.00"}) |
| Parameter | Type | Description |
|---|
lineItem | object | HubSpot line item record |
↳ name | string | Line item name |
↳ description | string | Full description of the product |
↳ hs_sku | string | Unique product identifier (SKU) |
↳ quantity | string | Number of units included |
↳ price | string | Unit price |
↳ amount | string | Total cost (quantity * unit price) |
↳ hs_line_item_currency_code | string | Currency code |
↳ recurringbillingfrequency | string | Recurring billing frequency |
↳ hs_recurring_billing_start_date | string | Recurring billing start date |
↳ hs_recurring_billing_end_date | string | Recurring billing end date |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
lineItemId | string | The updated line item ID |
success | boolean | Operation success status |
Retrieve all quotes from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_title,hs_expiration_date,hs_status") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,line_items") |
| Parameter | Type | Description |
|---|
quotes | array | Array of HubSpot quote records |
↳ hs_title | string | Quote name/title |
↳ hs_expiration_date | string | Expiration date |
↳ hs_status | string | Quote status |
↳ hs_esign_enabled | string | Whether e-signatures are enabled |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single quote by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
quoteId | string | Yes | The HubSpot quote ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_title,hs_expiration_date,hs_status") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,line_items") |
| Parameter | Type | Description |
|---|
quote | object | HubSpot quote record |
↳ hs_title | string | Quote name/title |
↳ hs_expiration_date | string | Expiration date |
↳ hs_status | string | Quote status |
↳ hs_esign_enabled | string | Whether e-signatures are enabled |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
quoteId | string | The retrieved quote ID |
success | boolean | Operation success status |
Retrieve all appointments from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_meeting_title,hs_meeting_start_time") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
appointments | array | Array of HubSpot appointment records |
↳ hs_appointment_type | string | Appointment type |
↳ hs_meeting_title | string | Meeting title |
↳ hs_meeting_start_time | string | Start time (ISO 8601) |
↳ hs_meeting_end_time | string | End time (ISO 8601) |
↳ hs_meeting_location | string | Meeting location |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single appointment by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
appointmentId | string | Yes | The HubSpot appointment ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_meeting_title,hs_meeting_start_time") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
appointment | object | HubSpot appointment record |
↳ hs_appointment_type | string | Appointment type |
↳ hs_meeting_title | string | Meeting title |
↳ hs_meeting_start_time | string | Start time (ISO 8601) |
↳ hs_meeting_end_time | string | End time (ISO 8601) |
↳ hs_meeting_location | string | Meeting location |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
appointmentId | string | The retrieved appointment ID |
success | boolean | Operation success status |
Create a new appointment in HubSpot
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Appointment properties as JSON object (e.g., {"hs_meeting_title": "Discovery Call", "hs_meeting_start_time": "2024-01-15T10:00:00Z", "hs_meeting_end_time": "2024-01-15T11:00:00Z"}) |
associations | array | No | Array of associations to create with the appointment as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
appointment | object | HubSpot appointment record |
↳ hs_appointment_type | string | Appointment type |
↳ hs_meeting_title | string | Meeting title |
↳ hs_meeting_start_time | string | Start time (ISO 8601) |
↳ hs_meeting_end_time | string | End time (ISO 8601) |
↳ hs_meeting_location | string | Meeting location |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
appointmentId | string | The created appointment ID |
success | boolean | Operation success status |
Update an existing appointment in HubSpot by ID
| Parameter | Type | Required | Description |
|---|
appointmentId | string | Yes | The HubSpot appointment ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | object | Yes | Appointment properties to update as JSON object (e.g., {"hs_meeting_title": "Updated Call", "hs_meeting_location": "Zoom"}) |
| Parameter | Type | Description |
|---|
appointment | object | HubSpot appointment record |
↳ hs_appointment_type | string | Appointment type |
↳ hs_meeting_title | string | Meeting title |
↳ hs_meeting_start_time | string | Start time (ISO 8601) |
↳ hs_meeting_end_time | string | End time (ISO 8601) |
↳ hs_meeting_location | string | Meeting location |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
appointmentId | string | The updated appointment ID |
success | boolean | Operation success status |
Retrieve all carts from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for |
| Parameter | Type | Description |
|---|
carts | array | Array of HubSpot CRM records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Record properties |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single cart by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
cartId | string | Yes | The HubSpot cart ID to retrieve |
properties | string | No | Comma-separated list of HubSpot property names to return |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for |
| Parameter | Type | Description |
|---|
cart | object | HubSpot CRM record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Record properties |
↳ associations | object | Associated records |
cartId | string | The retrieved cart ID |
success | boolean | Operation success status |
Retrieve all owners from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 100) |
after | string | No | Pagination cursor for next page of results (from previous response) |
email | string | No | Filter owners by email address |
| Parameter | Type | Description |
|---|
owners | array | Array of HubSpot owner objects |
↳ id | string | Owner ID |
↳ email | string | Owner email address |
↳ firstName | string | Owner first name |
↳ lastName | string | Owner last name |
↳ userId | number | Associated user ID |
↳ teams | array | Teams the owner belongs to |
↳ id | string | Team ID |
↳ name | string | Team name |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
↳ archived | boolean | Whether the owner is archived |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve all marketing events from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
| Parameter | Type | Description |
|---|
events | array | Array of HubSpot marketing event objects |
↳ objectId | string | Unique event ID (HubSpot internal) |
↳ eventName | string | Event name |
↳ eventType | string | Event type |
↳ eventStatus | string | Event status |
↳ eventDescription | string | Event description |
↳ eventUrl | string | Event URL |
↳ eventOrganizer | string | Event organizer |
↳ startDateTime | string | Start date/time (ISO 8601) |
↳ endDateTime | string | End date/time (ISO 8601) |
↳ eventCancelled | boolean | Whether event is cancelled |
↳ eventCompleted | boolean | Whether event is completed |
↳ registrants | number | Number of registrants |
↳ attendees | number | Number of attendees |
↳ cancellations | number | Number of cancellations |
↳ noShows | number | Number of no-shows |
↳ externalEventId | string | External event ID |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single marketing event by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
eventId | string | Yes | The HubSpot marketing event objectId to retrieve |
| Parameter | Type | Description |
|---|
event | object | HubSpot marketing event |
↳ objectId | string | Unique event ID (HubSpot internal) |
↳ eventName | string | Event name |
↳ eventType | string | Event type |
↳ eventStatus | string | Event status |
↳ eventDescription | string | Event description |
↳ eventUrl | string | Event URL |
↳ eventOrganizer | string | Event organizer |
↳ startDateTime | string | Start date/time (ISO 8601) |
↳ endDateTime | string | End date/time (ISO 8601) |
↳ eventCancelled | boolean | Whether event is cancelled |
↳ eventCompleted | boolean | Whether event is completed |
↳ registrants | number | Number of registrants |
↳ attendees | number | Number of attendees |
↳ cancellations | number | Number of cancellations |
↳ noShows | number | Number of no-shows |
↳ externalEventId | string | External event ID |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
eventId | string | The retrieved marketing event ID |
success | boolean | Operation success status |
Search and retrieve lists from HubSpot account
| Parameter | Type | Required | Description |
|---|
query | string | No | Search query to filter lists by name. Leave empty to return all lists. |
count | string | No | Maximum number of results to return (default 20, max 500) |
offset | string | No | Pagination offset for next page of results (use the offset value from previous response) |
| Parameter | Type | Description |
|---|
lists | array | Array of HubSpot list objects |
↳ listId | string | List ID |
↳ name | string | List name |
↳ objectTypeId | string | Object type ID (e.g., 0-1 for contacts) |
↳ processingType | string | Processing type (MANUAL, DYNAMIC, SNAPSHOT) |
↳ processingStatus | string | Processing status (COMPLETE, PROCESSING) |
↳ listVersion | number | List version number |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
paging | object | Pagination information for fetching more results |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
↳ total | number | Total number of lists matching the query |
success | boolean | Operation success status |
Retrieve a single list by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
listId | string | Yes | The HubSpot list ID to retrieve |
| Parameter | Type | Description |
|---|
list | object | HubSpot list |
↳ listId | string | List ID |
↳ name | string | List name |
↳ objectTypeId | string | Object type ID (e.g., 0-1 for contacts) |
↳ processingType | string | Processing type (MANUAL, DYNAMIC, SNAPSHOT) |
↳ processingStatus | string | Processing status (COMPLETE, PROCESSING) |
↳ listVersion | number | List version number |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
listId | string | The retrieved list ID |
success | boolean | Operation success status |
Create a new list in HubSpot. Specify the object type and processing type (MANUAL or DYNAMIC)
| Parameter | Type | Required | Description |
|---|
name | string | Yes | Name of the list |
objectTypeId | string | Yes | Object type ID (e.g., "0-1" for contacts, "0-2" for companies) |
processingType | string | Yes | Processing type: "MANUAL" for static lists or "DYNAMIC" for active lists |
| Parameter | Type | Description |
|---|
list | object | HubSpot list |
↳ listId | string | List ID |
↳ name | string | List name |
↳ objectTypeId | string | Object type ID (e.g., 0-1 for contacts) |
↳ processingType | string | Processing type (MANUAL, DYNAMIC, SNAPSHOT) |
↳ processingStatus | string | Processing status (COMPLETE, PROCESSING) |
↳ listVersion | number | List version number |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
listId | string | The created list ID |
success | boolean | Operation success status |
A workflow can start when one of these HubSpot events occurs.
Trigger workflow when a new contact is created in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a contact is deleted in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when contacts are merged in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing merge event details |
↳ objectId | number | HubSpot object ID (winning/primary record) |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ mergedObjectIds | array | IDs of the objects that were merged into the primary record |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_contact_merged) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
Trigger workflow when a contact is deleted for privacy compliance (GDPR, CCPA, etc.) in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when any property of a contact is updated in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Property Name (Optional) | text | Optional: Filter to only trigger when a specific property changes. Leave empty to trigger on any property change. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a deleted contact is restored in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a new company is created in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a company is deleted in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when companies are merged in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing merge event details |
↳ objectId | number | HubSpot object ID (winning/primary record) |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ mergedObjectIds | array | IDs of the objects that were merged into the primary record |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_contact_merged) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
Trigger workflow when any property of a company is updated in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Property Name (Optional) | text | Optional: Filter to only trigger when a specific property changes. Leave empty to trigger on any property change. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a deleted company is restored in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a new conversation is created in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a conversation is deleted in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a new message is added to a conversation in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a conversation is deleted for privacy compliance (GDPR, CCPA, etc.) in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when any property of a conversation is updated in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Property Name (Optional) | text | Optional: Filter to only trigger when a specific property changes. Leave empty to trigger on any property change. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a new deal is created in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a deal is deleted in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when deals are merged in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing merge event details |
↳ objectId | number | HubSpot object ID (winning/primary record) |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ mergedObjectIds | array | IDs of the objects that were merged into the primary record |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_contact_merged) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
Trigger workflow when any property of a deal is updated in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Property Name (Optional) | text | Optional: Filter to only trigger when a specific property changes. Leave empty to trigger on any property change. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a deleted deal is restored in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a new ticket is created in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a ticket is deleted in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when tickets are merged in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing merge event details |
↳ objectId | number | HubSpot object ID (winning/primary record) |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ mergedObjectIds | array | IDs of the objects that were merged into the primary record |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_contact_merged) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
Trigger workflow when any property of a ticket is updated in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Property Name (Optional) | text | Optional: Filter to only trigger when a specific property changes. Leave empty to trigger on any property change. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow when a deleted ticket is restored in HubSpot
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |
Trigger workflow on any HubSpot webhook event
HubSpot sends the event to the webhook URL shown in the block.
| Field | Type | Description |
|---|
| Client ID | text | Found in your HubSpot app settings under Auth tab |
| Client Secret | text | Found in your HubSpot app settings under Auth tab |
| App ID | text | Found in your HubSpot app settings. Used to identify your app. |
| Developer API Key | text | Used for making API calls to HubSpot. Found in your HubSpot app settings. |
| Field | Type | Description |
|---|
payload | array | Full webhook payload array from HubSpot containing event details |
↳ objectId | number | HubSpot object ID |
↳ subscriptionType | string | Type of subscription event |
↳ portalId | number | HubSpot portal ID |
↳ occurredAt | number | Timestamp when event occurred (ms) |
↳ attemptNumber | number | Webhook delivery attempt number |
↳ eventId | number | Event ID |
↳ changeSource | string | Source of the change |
↳ propertyName | string | Property name (for propertyChange events) |
↳ propertyValue | string | New property value (for propertyChange events) |
provider | string | Provider name (hubspot) |
providerConfig | object | Provider configuration |
↳ appId | string | HubSpot App ID |
↳ clientId | string | HubSpot Client ID |
↳ triggerId | string | Trigger ID (e.g., hubspot_company_created) |
↳ clientSecret | string | HubSpot Client Secret |
↳ developerApiKey | string | HubSpot Developer API Key |
↳ curlSetWebhookUrl | string | curl command to set webhook URL |
↳ curlCreateSubscription | string | curl command to create subscription |
↳ webhookUrlDisplay | string | Webhook URL display value |
↳ propertyName | string | Optional property name filter (for property change triggers) |