HubSpot
Interact with HubSpot CRM or trigger workflows from HubSpot events
Integrate HubSpot into your workflow. Manage contacts, companies, deals, tickets, and other CRM objects with powerful automation capabilities. Can be used in trigger mode to start workflows when contacts are created, deleted, or updated.
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
contactId | string | Yes | No description |
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 |
| Parameter | Type | Required | Description |
|---|
contactId | string | Yes | No description |
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 |
| 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 | No description |
after | string | No | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | No description |
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 |
| 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 |
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | No description |
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 |
| 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 | No description |
after | string | No | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
dealId | string | Yes | No description |
idProperty | string | No | No description |
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 |
| 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 |
| Parameter | Type | Required | Description |
|---|
dealId | string | Yes | No description |
idProperty | string | No | No description |
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 |
| 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 | No description |
properties | array | No | Array of HubSpot property names to return (e.g., ["dealname", "amount", "dealstage"]) |
limit | number | No | No description |
after | string | No | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
ticketId | string | Yes | No description |
idProperty | string | No | No description |
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 |
| 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 |
| Parameter | Type | Required | Description |
|---|
ticketId | string | Yes | No description |
idProperty | string | No | No description |
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 |
| 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 | No description |
properties | array | No | Array of HubSpot property names to return (e.g., ["subject", "content", "hs_ticket_priority"]) |
limit | number | No | No description |
after | string | No | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
lineItemId | string | Yes | No description |
idProperty | string | No | No description |
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 |
| 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 |
| Parameter | Type | Required | Description |
|---|
lineItemId | string | Yes | No description |
idProperty | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
quoteId | string | Yes | No description |
idProperty | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
appointmentId | string | Yes | No description |
idProperty | string | No | No description |
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 |
| 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 |
| Parameter | Type | Required | Description |
|---|
appointmentId | string | Yes | No description |
idProperty | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
properties | string | No | No description |
associations | string | No | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
cartId | string | Yes | No description |
properties | string | No | No description |
associations | string | No | No description |
| 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 |
Get a list of products from HubSpot
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of products to return (default 10, max 100) |
after | string | No | Cursor for pagination (get from previous response paging.next.after) |
properties | string | No | Comma-separated list of properties to return |
| Parameter | Type | Description |
|---|
products | 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 |
total | number | Total number of products returned |
success | boolean | Operation success status |
Create a new product in HubSpot
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Product properties as JSON object. Must include name (e.g., {"name": "My Product", "price": "99.99", "description": "Product description"}) |
associations | array | No | Array of associations to create with the product as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
product | 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 |
productId | string | The created product ID |
success | boolean | Operation success status |
Update an existing product in HubSpot
| Parameter | Type | Required | Description |
|---|
productId | string | Yes | ID of the product to update |
properties | object | Yes | Product properties to update as JSON object (e.g., {"name": "Updated Name", "price": "149.99"}) |
| Parameter | Type | Description |
|---|
product | 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 |
productId | string | The updated product ID |
success | boolean | Operation success status |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
users | json | Array of user objects |
contacts | json | Array of contact objects |
contact | json | Single contact object |
companies | json | Array of company objects |
company | json | Single company object |
deals | json | Array of deal objects |
deal | json | Single deal object |
tickets | json | Array of ticket objects |
ticket | json | Single ticket object |
lineItems | json | Array of line item objects |
lineItem | json | Single line item object |
quotes | json | Array of quote objects |
quote | json | Single quote object |
appointments | json | Array of appointment objects |
appointment | json | Single appointment object |
carts | json | Array of cart objects |
cart | json | Single cart object |
owners | json | Array of owner objects |
events | json | Array of marketing event objects |
event | json | Single marketing event object |
lists | json | Array of list objects |
list | json | Single list object |
total | number | Total number of matching results (for search) |
paging | json | Pagination info with next/prev cursors |
metadata | json | Operation metadata |
success | boolean | Operation success status |
payload | json | Full webhook payload array from HubSpot containing event details |
provider | string | Provider name (hubspot) |
providerConfig | string | HubSpot App ID |
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) |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
users | json | Array of user objects |
contacts | json | Array of contact objects |
contact | json | Single contact object |
companies | json | Array of company objects |
company | json | Single company object |
deals | json | Array of deal objects |
deal | json | Single deal object |
tickets | json | Array of ticket objects |
ticket | json | Single ticket object |
lineItems | json | Array of line item objects |
lineItem | json | Single line item object |
quotes | json | Array of quote objects |
quote | json | Single quote object |
appointments | json | Array of appointment objects |
appointment | json | Single appointment object |
carts | json | Array of cart objects |
cart | json | Single cart object |
owners | json | Array of owner objects |
events | json | Array of marketing event objects |
event | json | Single marketing event object |
lists | json | Array of list objects |
list | json | Single list object |
total | number | Total number of matching results (for search) |
paging | json | Pagination info with next/prev cursors |
metadata | json | Operation metadata |
success | boolean | Operation success status |
payload | json | Full webhook payload array from HubSpot containing event details |
provider | string | Provider name (hubspot) |
providerConfig | string | HubSpot App ID |
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) |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
users | json | Array of user objects |
contacts | json | Array of contact objects |
contact | json | Single contact object |
companies | json | Array of company objects |
company | json | Single company object |
deals | json | Array of deal objects |
deal | json | Single deal object |
tickets | json | Array of ticket objects |
ticket | json | Single ticket object |
lineItems | json | Array of line item objects |
lineItem | json | Single line item object |
quotes | json | Array of quote objects |
quote | json | Single quote object |
appointments | json | Array of appointment objects |
appointment | json | Single appointment object |
carts | json | Array of cart objects |
cart | json | Single cart object |
owners | json | Array of owner objects |
events | json | Array of marketing event objects |
event | json | Single marketing event object |
lists | json | Array of list objects |
list | json | Single list object |
total | number | Total number of matching results (for search) |
paging | json | Pagination info with next/prev cursors |
metadata | json | Operation metadata |
success | boolean | Operation success status |
payload | json | Full webhook payload array from HubSpot containing event details |
provider | string | Provider name (hubspot) |
providerConfig | string | HubSpot App ID |
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) |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
users | json | Array of user objects |
contacts | json | Array of contact objects |
contact | json | Single contact object |
companies | json | Array of company objects |
company | json | Single company object |
deals | json | Array of deal objects |
deal | json | Single deal object |
tickets | json | Array of ticket objects |
ticket | json | Single ticket object |
lineItems | json | Array of line item objects |
lineItem | json | Single line item object |
quotes | json | Array of quote objects |
quote | json | Single quote object |
appointments | json | Array of appointment objects |
appointment | json | Single appointment object |
carts | json | Array of cart objects |
cart | json | Single cart object |
owners | json | Array of owner objects |
events | json | Array of marketing event objects |
event | json | Single marketing event object |
lists | json | Array of list objects |
list | json | Single list object |
total | number | Total number of matching results (for search) |
paging | json | Pagination info with next/prev cursors |
metadata | json | Operation metadata |
success | boolean | Operation success status |
payload | json | Full webhook payload array from HubSpot containing event details |
provider | string | Provider name (hubspot) |
providerConfig | string | HubSpot App ID |
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) |
Create a task in HubSpot
| Parameter | Type | Required | Description |
|---|
hsTaskSubject | string | Yes | Task subject/title |
hsTaskBody | string | No | Task body/notes |
hsTaskPriority | string | No | Task priority: HIGH, MEDIUM, or LOW |
hsTaskStatus | string | No | Task status: NOT_STARTED, IN_PROGRESS, COMPLETED, DEFERRED, or WAITING |
hsTimestamp | string | No | Task due date (ISO 8601 or Unix ms) |
associations | array | No | Array of associations as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
task | 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 |
taskId | string | The created task ID |
success | boolean | Operation success status |
Get all properties for a HubSpot CRM object type
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | Object type: contacts, companies, deals, tickets, products, line_items, calls, emails, meetings, notes, tasks, feedback_submissions |
| Parameter | Type | Description |
|---|
properties | array | Array of property definitions |
↳ name | string | Property internal name |
↳ label | string | Property display label |
↳ type | string | Property data type |
↳ fieldType | string | Property field type |
↳ description | string | Property description |
↳ groupName | string | Property group name |
success | boolean | Operation success status |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
users | json | Array of user objects |
contacts | json | Array of contact objects |
contact | json | Single contact object |
companies | json | Array of company objects |
company | json | Single company object |
deals | json | Array of deal objects |
deal | json | Single deal object |
tickets | json | Array of ticket objects |
ticket | json | Single ticket object |
lineItems | json | Array of line item objects |
lineItem | json | Single line item object |
quotes | json | Array of quote objects |
quote | json | Single quote object |
appointments | json | Array of appointment objects |
appointment | json | Single appointment object |
carts | json | Array of cart objects |
cart | json | Single cart object |
owners | json | Array of owner objects |
events | json | Array of marketing event objects |
event | json | Single marketing event object |
lists | json | Array of list objects |
list | json | Single list object |
total | number | Total number of matching results (for search) |
paging | json | Pagination info with next/prev cursors |
metadata | json | Operation metadata |
success | boolean | Operation success status |
payload | json | Full webhook payload array from HubSpot containing event details |
provider | string | Provider name (hubspot) |
providerConfig | string | HubSpot App ID |
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) |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
email | string | No | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
limit | string | No | No description |
after | string | No | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
eventId | string | Yes | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
query | string | No | No description |
count | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
listId | string | Yes | No description |
| 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 | No description |
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 |