HubSpot
Create, find and update contacts, companies, deals and tickets in HubSpot, log notes, tasks, calls, emails and meetings, link records, and manage list members.
Connect HubSpot
- In the sidebar, open Connections and press Add connection.
- Type
hubspotand choose HubSpot. - Choose Sign in with HubSpot.
- Press Sign in with HubSpot at the bottom of the sheet, then choose your account in HubSpot’s window and allow access.
Or choose Paste your private app access token, paste it, and press Test and save. It stays until someone deletes it.
Sign in with HubSpot, or paste a private app access token (HubSpot › Settings › Integrations › Private Apps, or a static-token app under Development › Apps) with the CRM scopes you need.
What if it says “Sign-in isn’t set up here yet”?
Signing in with HubSpot needs a HubSpot app on this installation, and it has none yet. Until it is set up, Paste your private app access token works without it.
On Cloud: The sheet says “It’s set up once for everyone who uses this service, not by an organization.”
Self-hosted: An admin of the installation sees Set up HubSpot sign-in instead, and sets it up once for everyone. Everyone else sees who to ask.
- Create an app in HubSpot’s developer settings (HubSpot’s guide).
- In GoRunner, copy the Redirect address to add in HubSpot’s developer settings, and add it to the app.
- Paste the Client ID and Client secret, then press Save and sign in.
Can I use my own HubSpot app?
Yes. In the sheet, open Use your own HubSpot app and paste its Client ID and Client secret. Add the redirect address it shows to your app first. The connection then signs in through your app instead of the installation’s.
Connections says how to sign in again, rename or delete it. In a product that embeds GoRunner, Add connection can be missing: then your provider makes connections for you.
Start a workflow
Add a trigger and choose HubSpot. The trigger uses the same connection as the steps.
On Record Created or Updated
Checks HubSpot about once a minute and starts a run for each contact, company, deal or ticket created, or changed, since the check before (oldest first, at most 200 a minute; more wait for the next check). The first check after publishing only takes note of where things stand (it starts nothing); changing the trigger starts over the same way. "Record updated" fires once per saved change, except the saves in a record's first two minutes, which count as creating it; "Record created or updated" fires for both. A record HubSpot needs a few moments to make searchable is still picked up on a later check.
- Object · Required
Which records to watch.
Options: Contact, Company, Deal, Ticket.
Default: Contact.
- Trigger on · Required
Which changes start a run.
Options: Record created, Record updated, Record created or updated.
Default: Record created.
- Properties to Return · Optional
Internal property names to include, separated by commas. Empty returns the object's usual ones (name, email, stage, owner, dates).
- Only Records Matching · Optional
Watch only records these HubSpot filter groups keep, such as [{"filters": [{"propertyName": "pipeline", "operator": "EQ", "value": "default"}]}]. Empty watches every record.
A later step can use its data, such as {{trigger.archived}}, {{trigger.change_type}}, {{trigger.createdAt}} and 5 more. See Use data from earlier steps.
Do things in HubSpot
Add a HubSpot step, choose a Resource, then an Operation. Choose a row to see its fields.
- ContactCreate · Create or Update · Get · Get Many · Get Recently Created or Updated · Search · Update · Delete
- CompanyCreate · Get · Get Many · Get Recently Created or Updated · Search · Search by Domain · Update · Delete
- DealCreate · Get · Get Many · Get Recently Created or Updated · Search · Update · Delete
- TicketCreate · Get · Get Many · Search · Update · Delete
- EngagementCreate · Get · Get Many · Update · Delete
- AssociationCreate · Get Many · Get Labels · Delete
- ListAdd Contacts · Remove Contacts · Get Many
- OwnerGet · Get Many
- PipelineGet · Get Many
- PropertyGet · Get Many
Later steps read a step’s output by its name: see Use data from earlier steps.
Limits
- A reply from HubSpot can be up to 16 MB (a file download can have its own limit). A larger one fails the step; it is never cut short.
- When HubSpot says to slow down (429), the step waits as long as it asks, if the step’s time allows. Otherwise it fails and says when to try again.
Not in your list? See When an app isn’t here.
For developers
In the API, which calls apps pieces, HubSpot is pieceId: "hubspot" with actionId: "hubspot", set by resource and an operation_… field, such as operation_association. Its trigger is hubspottrigger / hubspot_poll. Get an app returns every field.
It can change something outside the run (writes_external). See How versions and side effects work.
HubSpot › Contact
Create
- Email · Optional
The contact's email address. Create or Update finds the contact by it.
- First Name · Optional
- Last Name · Optional
- Phone · Optional
- Company Name · Optional
The company name on the contact (text; to link a company record, use Associated Companies).
- Job Title · Optional
- Lifecycle Stage · Optional
Options: Subscriber, Lead, Marketing qualified lead, Sales qualified lead, Opportunity, Customer, Evangelist, Other.
- Owner · Optional
The HubSpot user who owns the contact.
- More Properties · Optional
More property values by internal name, such as {"city": "Berlin", "hs_lead_status": "NEW"}. A list sets a multiple-choice property; null or "" clears a value. The fields above win over the same name here.
- Associated Companies · Optional
Record ids of companies to associate the new contact with, separated by commas.
- Associated Deals · Optional
Record ids of deals to associate the new contact with, separated by commas.
- Associated Tickets · Optional
Record ids of tickets to associate the new contact with, separated by commas.
Create or Update
- Email · Required
The email that identifies the contact: HubSpot updates the contact with this email, or creates one.
- First Name · Optional
- Last Name · Optional
- Phone · Optional
- Company Name · Optional
The company name on the contact (text; to link a company record, use Associated Companies).
- Job Title · Optional
- Lifecycle Stage · Optional
Options: Subscriber, Lead, Marketing qualified lead, Sales qualified lead, Opportunity, Customer, Evangelist, Other.
- Owner · Optional
The HubSpot user who owns the contact.
- More Properties · Optional
More property values by internal name, such as {"city": "Berlin", "hs_lead_status": "NEW"}. A list sets a multiple-choice property; null or "" clears a value. The fields above win over the same name here.
Get
- Contact ID · Required
The contact's record id, its record link, or its email address.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns email, firstname, lastname, phone, company, jobtitle, lifecyclestage, hubspot_owner_id, createdate, lastmodifieddate.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Get Many
- Return All · Optional
Read every contact, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many contacts to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns email, firstname, lastname, phone, company, jobtitle, lifecyclestage, hubspot_owner_id, createdate, lastmodifieddate.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Get Recently Created or Updated
- Changed Since · Optional
Only contacts created or changed at or after this time (a date, an ISO time or epoch milliseconds). Empty: the most recent first, no limit in time.
- Return All · Optional
Read every contact, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many contacts to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns email, firstname, lastname, phone, company, jobtitle, lifecyclestage, hubspot_owner_id, createdate, lastmodifieddate.
Search
- Search Text · Optional
Text to find in the contact's default searchable properties (name, email, domain, phone …). Empty matches all.
- Filter Property · Optional
Keep only records whose property matches (one condition; use Filter Groups for more).
- Filter Operator · Optional
Options: Is, Is not, Is less than, Is at most, Is greater than, Is at least, Contains word, Does not contain word, Is known, Is unknown, Is any of, Is none of.
Default: Is.
- Filter Value · Optional
The value to compare with. For Is Any Of / Is None Of, values separated by commas. Dates as epoch milliseconds or YYYY-MM-DD.
- Filter Groups · Optional
HubSpot filter groups, such as [{"filters": [{"propertyName": "lifecyclestage", "operator": "EQ", "value": "lead"}]}]. Filters in a group must all match; any group may match. At most 5 groups, 6 filters each, 18 in all.
- Sort By · Optional
The property to sort by. Empty sorts by when the record was created, oldest first.
- Sort Direction · Optional
Options: Ascending, Descending.
Default: Descending.
- Return All · Optional
Read every contact, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many contacts to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns email, firstname, lastname, phone, company, jobtitle, lifecyclestage, hubspot_owner_id, createdate, lastmodifieddate.
Update
- Contact ID · Required
The contact's record id, its record link, or its email address.
- Email · Optional
The contact's email address. Create or Update finds the contact by it.
- First Name · Optional
- Last Name · Optional
- Phone · Optional
- Company Name · Optional
The company name on the contact (text; to link a company record, use Associated Companies).
- Job Title · Optional
- Lifecycle Stage · Optional
Options: Subscriber, Lead, Marketing qualified lead, Sales qualified lead, Opportunity, Customer, Evangelist, Other.
- Owner · Optional
The HubSpot user who owns the contact.
- More Properties · Optional
More property values by internal name, such as {"city": "Berlin", "hs_lead_status": "NEW"}. A list sets a multiple-choice property; null or "" clears a value. The fields above win over the same name here.
Delete
- Contact ID · Required
The contact's record id, its record link, or its email address.
HubSpot › Company
Create
- Name · Optional
The company's name.
- Domain · Optional
The company's website domain (example.com); HubSpot fills in more details from it.
- Industry · Optional
One of HubSpot's industry values, such as COMPUTER_SOFTWARE.
- Phone · Optional
- City · Optional
- Country · Optional
- Owner · Optional
The HubSpot user who owns the company.
- More Properties · Optional
More property values by internal name, such as {"city": "Berlin", "hs_lead_status": "NEW"}. A list sets a multiple-choice property; null or "" clears a value. The fields above win over the same name here.
- Associated Contacts · Optional
Record ids of contacts to associate the new company with, separated by commas.
- Associated Deals · Optional
Record ids of deals to associate the new company with, separated by commas.
- Associated Tickets · Optional
Record ids of tickets to associate the new company with, separated by commas.
Get
- Company ID · Required
The company's record id (in the record's address in HubSpot), or the record's link.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns name, domain, industry, phone, city, country, hubspot_owner_id, createdate, hs_lastmodifieddate.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Get Many
- Return All · Optional
Read every company, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many companys to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns name, domain, industry, phone, city, country, hubspot_owner_id, createdate, hs_lastmodifieddate.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Get Recently Created or Updated
- Changed Since · Optional
Only companies created or changed at or after this time (a date, an ISO time or epoch milliseconds). Empty: the most recent first, no limit in time.
- Return All · Optional
Read every company, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many companys to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns name, domain, industry, phone, city, country, hubspot_owner_id, createdate, hs_lastmodifieddate.
Search
- Search Text · Optional
Text to find in the company's default searchable properties (name, email, domain, phone …). Empty matches all.
- Filter Property · Optional
Keep only records whose property matches (one condition; use Filter Groups for more).
- Filter Operator · Optional
Options: Is, Is not, Is less than, Is at most, Is greater than, Is at least, Contains word, Does not contain word, Is known, Is unknown, Is any of, Is none of.
Default: Is.
- Filter Value · Optional
The value to compare with. For Is Any Of / Is None Of, values separated by commas. Dates as epoch milliseconds or YYYY-MM-DD.
- Filter Groups · Optional
HubSpot filter groups, such as [{"filters": [{"propertyName": "lifecyclestage", "operator": "EQ", "value": "lead"}]}]. Filters in a group must all match; any group may match. At most 5 groups, 6 filters each, 18 in all.
- Sort By · Optional
The property to sort by. Empty sorts by when the record was created, oldest first.
- Sort Direction · Optional
Options: Ascending, Descending.
Default: Descending.
- Return All · Optional
Read every company, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many companys to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns name, domain, industry, phone, city, country, hubspot_owner_id, createdate, hs_lastmodifieddate.
Search by Domain
- Domain · Required
The website domain to find companies by (example.com; a URL works too).
- Return All · Optional
Read every company, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many companys to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns name, domain, industry, phone, city, country, hubspot_owner_id, createdate, hs_lastmodifieddate.
Update
- Company ID · Required
The company's record id (in the record's address in HubSpot), or the record's link.
- Name · Optional
The company's name.
- Domain · Optional
The company's website domain (example.com); HubSpot fills in more details from it.
- Industry · Optional
One of HubSpot's industry values, such as COMPUTER_SOFTWARE.
- Phone · Optional
- City · Optional
- Country · Optional
- Owner · Optional
The HubSpot user who owns the company.
- More Properties · Optional
More property values by internal name, such as {"city": "Berlin", "hs_lead_status": "NEW"}. A list sets a multiple-choice property; null or "" clears a value. The fields above win over the same name here.
Delete
- Company ID · Required
The company's record id (in the record's address in HubSpot), or the record's link.
HubSpot › Deal
Create
- Deal Name · Optional
Required when creating.
- Pipeline · Optional
The deal pipeline. Empty is the account's default pipeline.
- Stage · Optional
The deal stage, in the pipeline above. Required when creating.
- Amount · Optional
- Close Date · Optional
When the deal is expected to close: a date (2026-11-30) or an ISO time.
- Owner · Optional
The HubSpot user who owns the deal.
- More Properties · Optional
More property values by internal name, such as {"city": "Berlin", "hs_lead_status": "NEW"}. A list sets a multiple-choice property; null or "" clears a value. The fields above win over the same name here.
- Associated Contacts · Optional
Record ids of contacts to associate the new deal with, separated by commas.
- Associated Companies · Optional
Record ids of companies to associate the new deal with, separated by commas.
- Associated Tickets · Optional
Record ids of tickets to associate the new deal with, separated by commas.
Get
- Deal ID · Required
The deal's record id (in the record's address in HubSpot), or the record's link.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns dealname, amount, dealstage, pipeline, closedate, hubspot_owner_id, createdate, hs_lastmodifieddate.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Get Many
- Return All · Optional
Read every deal, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many deals to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns dealname, amount, dealstage, pipeline, closedate, hubspot_owner_id, createdate, hs_lastmodifieddate.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Get Recently Created or Updated
- Changed Since · Optional
Only deals created or changed at or after this time (a date, an ISO time or epoch milliseconds). Empty: the most recent first, no limit in time.
- Return All · Optional
Read every deal, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many deals to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns dealname, amount, dealstage, pipeline, closedate, hubspot_owner_id, createdate, hs_lastmodifieddate.
Search
- Search Text · Optional
Text to find in the deal's default searchable properties (name, email, domain, phone …). Empty matches all.
- Filter Property · Optional
Keep only records whose property matches (one condition; use Filter Groups for more).
- Filter Operator · Optional
Options: Is, Is not, Is less than, Is at most, Is greater than, Is at least, Contains word, Does not contain word, Is known, Is unknown, Is any of, Is none of.
Default: Is.
- Filter Value · Optional
The value to compare with. For Is Any Of / Is None Of, values separated by commas. Dates as epoch milliseconds or YYYY-MM-DD.
- Filter Groups · Optional
HubSpot filter groups, such as [{"filters": [{"propertyName": "lifecyclestage", "operator": "EQ", "value": "lead"}]}]. Filters in a group must all match; any group may match. At most 5 groups, 6 filters each, 18 in all.
- Sort By · Optional
The property to sort by. Empty sorts by when the record was created, oldest first.
- Sort Direction · Optional
Options: Ascending, Descending.
Default: Descending.
- Return All · Optional
Read every deal, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many deals to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns dealname, amount, dealstage, pipeline, closedate, hubspot_owner_id, createdate, hs_lastmodifieddate.
Update
- Deal ID · Required
The deal's record id (in the record's address in HubSpot), or the record's link.
- Deal Name · Optional
Required when creating.
- Pipeline · Optional
The deal pipeline. Empty is the account's default pipeline.
- Stage · Optional
The deal stage, in the pipeline above. Required when creating.
- Amount · Optional
- Close Date · Optional
When the deal is expected to close: a date (2026-11-30) or an ISO time.
- Owner · Optional
The HubSpot user who owns the deal.
- More Properties · Optional
More property values by internal name, such as {"city": "Berlin", "hs_lead_status": "NEW"}. A list sets a multiple-choice property; null or "" clears a value. The fields above win over the same name here.
Delete
- Deal ID · Required
The deal's record id (in the record's address in HubSpot), or the record's link.
HubSpot › Ticket
Create
- Ticket Name · Optional
Required when creating.
- Pipeline · Optional
The ticket pipeline. Required when creating.
- Stage · Optional
The ticket status, in the pipeline above. Required when creating.
- Description · Optional
- Priority · Optional
Options: Low, Medium, High, Urgent.
- Owner · Optional
The HubSpot user who owns the ticket.
- More Properties · Optional
More property values by internal name, such as {"city": "Berlin", "hs_lead_status": "NEW"}. A list sets a multiple-choice property; null or "" clears a value. The fields above win over the same name here.
- Associated Contacts · Optional
Record ids of contacts to associate the new ticket with, separated by commas.
- Associated Companies · Optional
Record ids of companies to associate the new ticket with, separated by commas.
- Associated Deals · Optional
Record ids of deals to associate the new ticket with, separated by commas.
Get
- Ticket ID · Required
The ticket's record id (in the record's address in HubSpot), or the record's link.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns subject, content, hs_pipeline, hs_pipeline_stage, hs_ticket_priority, hubspot_owner_id, createdate, hs_lastmodifieddate.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Get Many
- Return All · Optional
Read every ticket, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many tickets to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns subject, content, hs_pipeline, hs_pipeline_stage, hs_ticket_priority, hubspot_owner_id, createdate, hs_lastmodifieddate.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Search
- Search Text · Optional
Text to find in the ticket's default searchable properties (name, email, domain, phone …). Empty matches all.
- Filter Property · Optional
Keep only records whose property matches (one condition; use Filter Groups for more).
- Filter Operator · Optional
Options: Is, Is not, Is less than, Is at most, Is greater than, Is at least, Contains word, Does not contain word, Is known, Is unknown, Is any of, Is none of.
Default: Is.
- Filter Value · Optional
The value to compare with. For Is Any Of / Is None Of, values separated by commas. Dates as epoch milliseconds or YYYY-MM-DD.
- Filter Groups · Optional
HubSpot filter groups, such as [{"filters": [{"propertyName": "lifecyclestage", "operator": "EQ", "value": "lead"}]}]. Filters in a group must all match; any group may match. At most 5 groups, 6 filters each, 18 in all.
- Sort By · Optional
The property to sort by. Empty sorts by when the record was created, oldest first.
- Sort Direction · Optional
Options: Ascending, Descending.
Default: Descending.
- Return All · Optional
Read every ticket, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many tickets to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns subject, content, hs_pipeline, hs_pipeline_stage, hs_ticket_priority, hubspot_owner_id, createdate, hs_lastmodifieddate.
Update
- Ticket ID · Required
The ticket's record id (in the record's address in HubSpot), or the record's link.
- Ticket Name · Optional
Required when creating.
- Pipeline · Optional
The ticket pipeline. Required when creating.
- Stage · Optional
The ticket status, in the pipeline above. Required when creating.
- Description · Optional
- Priority · Optional
Options: Low, Medium, High, Urgent.
- Owner · Optional
The HubSpot user who owns the ticket.
- More Properties · Optional
More property values by internal name, such as {"city": "Berlin", "hs_lead_status": "NEW"}. A list sets a multiple-choice property; null or "" clears a value. The fields above win over the same name here.
Delete
- Ticket ID · Required
The ticket's record id (in the record's address in HubSpot), or the record's link.
HubSpot › Engagement
Create
- Type · Required
Which kind of activity.
Options: Note, Task, Call, Email, Meeting.
Default: Note.
- Subject · Optional
The task's subject, the call's or meeting's title, or the email's subject line.
Shows when Type is Task, Call, Email or Meeting.
- Body · Optional
The note's text, the task's notes, the call's notes, the email's body or the meeting's description (HTML is kept).
- When · Optional
When it happened (a task: when it is due), as a date, an ISO time or epoch milliseconds. Empty on Create is now.
- Status · Optional
Options: Busy, Calling crm user, Canceled, Completed, Connecting, Failed, In progress, No answer, Queued, Ringing.
Shows when Type is Call.
- Status · Optional
Options: Bounced, Failed, Scheduled, Sending, Sent.
Shows when Type is Email.
- Outcome · Optional
Options: Scheduled, Completed, Rescheduled, No show, Canceled.
Shows when Type is Meeting.
- Status · Optional
Options: Not started, In progress, Waiting, Completed, Deferred.
Shows when Type is Task.
- Direction · Optional
Options: Inbound, Outbound.
Shows when Type is Call.
- Direction · Optional
Options: Sent, Received (a reply), Forwarded.
Shows when Type is Email.
- Start · Optional
When the meeting starts (ISO time or epoch milliseconds).
Shows when Type is Meeting.
- Priority · Optional
Options: Low, Medium, High.
Shows when Type is Task.
- Duration (seconds) · Optional
Shows when Type is Call.
- End · Optional
When the meeting ends.
Shows when Type is Meeting.
- Task Type · Optional
Options: To-do, Call, Email.
Shows when Type is Task.
- Location · Optional
Shows when Type is Meeting.
- Owner · Optional
The HubSpot user the activity is assigned to.
- More Properties · Optional
More property values by internal name, such as {"hs_call_to_number": "+49 30 1234567"}. The fields above win over the same name here.
- Associated Contacts · Optional
Record ids of contacts whose timeline shows the activity, separated by commas.
- Associated Companies · Optional
Record ids of companies whose timeline shows the activity, separated by commas.
- Associated Deals · Optional
Record ids of deals whose timeline shows the activity, separated by commas.
- Associated Tickets · Optional
Record ids of tickets whose timeline shows the activity, separated by commas.
Get
- Type · Required
Which kind of activity.
Options: Note, Task, Call, Email, Meeting.
Default: Note.
- Engagement ID · Required
The activity's record id.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns the type's subject, body, status, time and owner.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets.
Get Many
- Type · Required
Which kind of activity.
Options: Note, Task, Call, Email, Meeting.
Default: Note.
- Return All · Optional
Read every engagement, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many engagements to return (1–2000).
Default: 50.
Shows when Return All is off.
- Properties to Return · Optional
Internal property names to return, separated by commas. Empty returns the type's subject, body, status, time and owner.
- Include Associations · Optional
Also return the ids of associated records of these types.
Options: Contacts, Companies, Deals, Tickets.
Update
- Type · Required
Which kind of activity.
Options: Note, Task, Call, Email, Meeting.
Default: Note.
- Engagement ID · Required
The activity's record id.
- Subject · Optional
The task's subject, the call's or meeting's title, or the email's subject line.
Shows when Type is Task, Call, Email or Meeting.
- Body · Optional
The note's text, the task's notes, the call's notes, the email's body or the meeting's description (HTML is kept).
- When · Optional
When it happened (a task: when it is due), as a date, an ISO time or epoch milliseconds. Empty on Create is now.
- Status · Optional
Options: Busy, Calling crm user, Canceled, Completed, Connecting, Failed, In progress, No answer, Queued, Ringing.
Shows when Type is Call.
- Status · Optional
Options: Bounced, Failed, Scheduled, Sending, Sent.
Shows when Type is Email.
- Outcome · Optional
Options: Scheduled, Completed, Rescheduled, No show, Canceled.
Shows when Type is Meeting.
- Status · Optional
Options: Not started, In progress, Waiting, Completed, Deferred.
Shows when Type is Task.
- Direction · Optional
Options: Inbound, Outbound.
Shows when Type is Call.
- Direction · Optional
Options: Sent, Received (a reply), Forwarded.
Shows when Type is Email.
- Start · Optional
When the meeting starts (ISO time or epoch milliseconds).
Shows when Type is Meeting.
- Priority · Optional
Options: Low, Medium, High.
Shows when Type is Task.
- Duration (seconds) · Optional
Shows when Type is Call.
- End · Optional
When the meeting ends.
Shows when Type is Meeting.
- Task Type · Optional
Options: To-do, Call, Email.
Shows when Type is Task.
- Location · Optional
Shows when Type is Meeting.
- Owner · Optional
The HubSpot user the activity is assigned to.
- More Properties · Optional
More property values by internal name, such as {"hs_call_to_number": "+49 30 1234567"}. The fields above win over the same name here.
Delete
- Type · Required
Which kind of activity.
Options: Note, Task, Call, Email, Meeting.
Default: Note.
- Engagement ID · Required
The activity's record id.
HubSpot › Association
Create
- From Object Type · Required
The type of the record the link starts at.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Contacts.
- From Record ID · Required
The record's id or record link.
- To Object Type · Required
The type of the record(s) at the other end.
Options: Companies, Contacts, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Companies.
- To Record ID · Required
The other record's id or record link.
- Label · Optional
The association label (Primary company, Decision maker …). Empty makes the default, unlabeled association.
Get Many
- From Object Type · Required
The type of the record the link starts at.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Contacts.
- From Record ID · Required
The record's id or record link.
- To Object Type · Required
The type of the record(s) at the other end.
Options: Companies, Contacts, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Companies.
- Return All · Optional
Read every association, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many associations to return (1–2000).
Default: 100.
Shows when Return All is off.
Get Labels
- From Object Type · Required
The type of the record the link starts at.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Contacts.
- To Object Type · Required
The type of the record(s) at the other end.
Options: Companies, Contacts, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Companies.
Delete
- From Object Type · Required
The type of the record the link starts at.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Contacts.
- From Record ID · Required
The record's id or record link.
- To Object Type · Required
The type of the record(s) at the other end.
Options: Companies, Contacts, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Companies.
- To Record ID · Required
The other record's id or record link.
HubSpot › List
Add Contacts and Remove Contacts
- List · Required
A static (manual) list: HubSpot decides the members of an active list itself.
- Contacts · Required
Contact record ids or email addresses, separated by commas (at most 100).
Get Many
- Name Contains · Optional
Text in the list's name. Empty finds every list.
- List Type · Optional
Options: Any, Static, Snapshot, Active.
- Return All · Optional
Read every list, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many lists to return (1–2000).
Default: 50.
Shows when Return All is off.
HubSpot › Owner
Get
- Owner ID · Required
The owner's id (what hubspot_owner_id holds).
Get Many
- Email · Optional
Only the owner with this email. Empty lists every owner.
- Return All · Optional
Read every owner, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many owners to return (1–2000).
Default: 100.
Shows when Return All is off.
HubSpot › Pipeline
Get
- Object Type · Required
Deal pipelines or ticket pipelines.
Options: Deals, Tickets.
Default: Deals.
- Pipeline · Required
The pipeline to read, with its stages.
Get Many
- Object Type · Required
Deal pipelines or ticket pipelines.
Options: Deals, Tickets.
Default: Deals.
HubSpot › Property
Get
- Object Type · Required
Whose properties.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Contacts.
- Property · Required
The property to read.
Get Many
- Object Type · Required
Whose properties.
Options: Contacts, Companies, Deals, Tickets, Notes, Tasks, Calls, Emails, Meetings.
Default: Contacts.