HubSpot actions

The HubSpot block reads and writes HubSpot CRM records and starts workflows on HubSpot events. For the plain-language guide, see HubSpot.

When to use it

Use it to read a closed deal, its quote and line items before invoicing, to look up products and owners, and to keep contacts, companies and deals in step with your ledger. Use the trigger to start a workflow when a deal, quote, company or contact changes.

Connection

• Provider id: hubspot. Sign-in (OAuth) connection.
• Pin an account with config.connection. Without it, the step uses the company's default HubSpot connection.
• Inbound events are routed to the connection whose HubSpot portal id matches the event's portalId.

Actions

Settings

Fields each write action reads

The create and update executors build HubSpot properties from named fields. They do not read the Studio Properties (JSON) field (properties), so set these fields in the workflow definition:

updateContact, updateCompany and updateDeal also need contactId, companyId or dealId.

Search actions read filterGroups, sorts, properties (array of property names), limit (default 10) and after (paging cursor). searchQuotes also reads quoteFilters. None of them read searchQuery. getContact, getCompany and getDeal read properties as an array of property names.

Output

The step output is the HubSpot response. Records carry id and properties; searches and batchReadProducts return results. For example {{steps.get_deal.properties.amount}}.

Trigger

Trigger config type hubspot_event; the event is stored in eventKind. The handler registers these event names:

The trigger schema also accepts quote.deletion, * (any event), a <object>.* prefix, and the derived quote.published, which matches a quote.propertyChange on hs_status whose new value is APPROVED, APPROVAL_NOT_NEEDED or PUBLISHED.

Which events are delivered. HubSpot subscriptions are declared in the Loopfour HubSpot app, not registered per connection. The app subscribes to: contact creation, deletion and email changes; company creation and deletion; deal creation, deletion and changes to dealstage and install_completed; quote creation and hs_status changes; ticket creation and deletion; and contact.privacyDeletion, conversation.creation, conversation.deletion, conversation.newMessage and conversation.privacyDeletion. A trigger on any other event name is valid but does not fire.

Matching:

• eventKind must equal the event name (or match * or a prefix).
• For a .propertyChange event, an optional propertyName must equal the changed property.
• An optional filter applies $eq, $ne, $in and similar operators to the event envelope, for example {"data.propertyValue": {"$eq": "closedwon"}}.

At run time the event is the run input under input.webhookEvent. Useful paths: {{input.webhookEvent.eventType}}, {{input.webhookEvent.payload.data.objectId}} (the HubSpot record id), {{input.webhookEvent.payload.data.propertyName}} and {{input.webhookEvent.payload.data.propertyValue}}.

Example

When a deal moves to closed won, read the deal and its owner.

{
  "name": "Closed-won deal to billing",
  "trigger": {
    "type": "hubspot_event",
    "eventKind": "deal.propertyChange",
    "propertyName": "dealstage",
    "filter": { "data.propertyValue": { "$eq": "closedwon" } }
  },
  "steps": [
    {
      "id": "get_deal",
      "type": "action",
      "name": "Read the deal",
      "action": "hubspot.getDeal",
      "config": {
        "dealId": "{{input.webhookEvent.payload.data.objectId}}",
        "properties": ["dealname", "amount", "closedate", "hubspot_owner_id"]
      }
    },
    {
      "id": "get_owner",
      "type": "action",
      "name": "Read the deal owner",
      "action": "hubspot.getOwner",
      "config": { "ownerId": "{{steps.get_deal.properties.hubspot_owner_id}}" }
    }
  ]
}

Live catalog

• GET /api/v1/blocks/hubspot returns the actions, fields and trigger events.
• GET /api/v1/blocks/hubspot/actions/<operation>/examples returns stored examples where they exist.

Errors and limits

• A HubSpot API error fails the step.
• getQuoteLineItems fails the step when HubSpot returns incomplete associations or pages, rather than returning a partial list.
• batchReadProducts takes 1 to 100 product ids after de-duplication. getOwner takes an owner id of 1 to 20 digits.