HubSpot CRM Events

Cloud Elements supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

Cloud Elements supports both webhooks and polling events for HubSpot CRM.

You can set up events for the following resources:

• Accounts
• Contacts
• Other objects that include created, updated, and deleted data.

Configure Polling Through the UI

To configure polling through the UI, follow the same steps to authenticate an element instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

Configure Polling Through API

To add polling when authenticating through the /instances API call, add the following to the configuration object in the JSON body. For more information about each parameter described here, see Parameters.

{
"event.notification.enabled": true,
"event.vendor.type": "polling",
"event.notification.callback.url": "<INSERT_YOUR_APPS_CALLBACK_URL>",
"event.notification.signature.key": "<INSERT_KEY>",
"event.objects": "<COMMA_SEPARATED_LIST>",
"event.poller.refresh_interval": "<TIME_IN_MINUTES>"
}

Example JSON with Polling

instance JSON with polling events enabled:

{
  "element": {
    "key": "hubspotcrm"
  },
  "providerData": {
    "code": "<AUTHORIZATION_GRANT_CODE>"
  },
  "configuration": {
    "authentication.type": "oauth2 OR apiKey",
    "oauth.callback.url": "<OAUTH2_ONLY_CALLBACK_URL>",
    "oauth.api.key": "<OAUTH2_ONLY_CONSUMER_KEY>",
    "oauth.api.secret": "<OAUTH2_ONLY_CONSUMER_SECRET>",
    "hubspot.authorization.apikey":"<API_KEY_ONLY_HAPIKEY>",
    "create.bulk.properties": "false",
    "filter.response.nulls": true,
    "event.notification.enabled": true,
    "event.vendor.type": "polling",
    "event.notification.callback.url": "https://mycoolapp.com",
    "event.notification.signature.key": "12345",
    "event.poller.refresh_interval": "5",
    "event.poller.configuration":{
      "accounts":{
        "url":"/hubs/crm/contacts?where=lastmodifieddate='${date}'",
        "idField":"vid",
        "filterByUpdatedDate":true,
        "datesConfiguration":{
          "updatedDateField":"properties.lastmodifieddate",
          "updatedDateFormat":"milliseconds",
          "createdDateField":"properties.createdate",
          "createdDateFormat":"milliseconds",
          "createdCheckTolerance": 10
        }
      }
    }
  },
  "tags": [
    "<Add_Your_Tag>"
  ],
  "name": "<INSTANCE_NAME>"
}

Webhooks

You can configure webhooks through the UI or through API in the JSON body of the /instances API call. First, you must set up webhooks in HubSpot.

Set Up Webhooks

Follow these steps to set up your Hubspot application with the endpoint.

1. Via a web browser, log in to your Hubspot developer account at https://app.hubspot.com/signup/developers.
2. In the developer app dashboard, select the app that you'd like to send webhooks for.
3. Select Webhook Subscriptions from the navigation items displayed on the left.
   
   The Webhooks page appears, where you see a field to enter the target URL.
4. In order to get this URL, create an instance on HubSpot Marketing element.
5. While creating an instance, enable Events under Events Configuration and select Webhook as the Vendor Event Type.
6. Click Create Instance.
7. Choose an account through which you'd like to create an instance.
8. You're now taken back to Cloud Elements. Select Instances on the navigation pane on your left and edit your instance.
9. You will see a field named Webhook URL as shown below.
   
   You can now copy the URL, complete step 4 and click Save.
10. Next, you'll need to set up individual subscriptions for each object and event type for which you'd like to receive a notification. Do this by clicking Create Subscription.
11. Now, follow the prompts to configure the subscription.

Set up Workflow Webhooks

Follow these steps to set up your Hubspot application with the endpoint.

1. To create a workflow webhook, go to https://app.hubspot.com/ and select the account through which you'd like to create an instance with Cloud Elements.
2. On the HubSpot Reports Dashboard, navigate to Automation > Workflows and click Create Workflow.
   
3. Set enrollment triggers and add an action. Make sure that workflow is on in the top-right corner.
   
   
   
4. Once you've created a workflow, you should be be to see the workflow ID in the URL.
   
   In the above example, 3024516 is the workflow ID.
5. Create an instance and enter this workflow ID in the corresponding field. 

Your workflow webhook is now created.

Configure Webhooks Through the UI

To configure webhooks through the UI, follow the same steps to authenticate an element instance, and then turn on events. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

Configure Webhooks Through API

To add webhooks when authenticating through the /instances API call, add the following to the configuration object in the JSON body. For more information about each parameter described here, see Parameters.

{
"event.notification.enabled": true,
"event.vendor.type": "polling",
"event.notification.callback.url": "<INSERT_YOUR_APPS_CALLBACK_URL>",
"event.notification.signature.key": "<INSERT_KEY>",
"event.objects": "<COMMA_SEPARATED_LIST>"
}

Example JSON with Webhooks

Instance JSON with webhooks events enabled:

{
  "element": {
    "key": "hubspotcrm"
  },
  "providerData": {
    "code": "<AUTHORIZATION_GRANT_CODE>"
  },
  "configuration": {
    "authentication.type": "oauth2 OR apiKey",
    "oauth.callback.url": "<OAUTH2_ONLY_CALLBACK_URL>",
    "oauth.api.key": "<OAUTH2_ONLY_CONSUMER_KEY>",
    "oauth.api.secret": "<OAUTH2_ONLY_CONSUMER_SECRET>",
    "hubspot.authorization.apikey":"<API_KEY_ONLY_HAPIKEY>",
    "create.bulk.properties": "false",
    "filter.response.nulls": true,
    "event.notification.enabled": true,
    "event.vendor.type": "webhooks",
    "event.notification.callback.url": "https://mycoolapp.com",
    "event.notification.signature.key": "12345",
    "event.objects": "Contact,Account"
  },
  "tags": [
    "<Add_Your_Tag>"
  ],
  "name": "<INSTANCE_NAME>"
}

Parameters

API parameters are in code formatting.