Configure Polling Through the UI

Note: Unless configured for a specific time zone, polling occurs in UTC.

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.

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>"}

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.

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.

Parameter

Description

Data Type

key

The element key.hubspotcrm

string

code

The authorization grant code returned from the API provider in an OAuth2 authentication workflow.

string

Namename

The name for the element instance created during authentication.

string

authentication.type

Identifies how you are authenticating with HubSpot CRM. Either oauth2 or apiKey.

string

Create Bulk Properties for Migrationcreate.bulk.properties

Identifies if you want to create custom properties in Hubspot for bulk uploads.

string, must be true (Yes) or false (No)

oauth.callback.url

OAuth 2.0 authentication only. The URL where you want to redirect users after they grant access. This is the Callback URL that you noted in API Provider Setup.

string

oauth.api.key

OAuth 2.0 authentication only. The Client ID from HubSpot CRM. This is the Client ID that you noted in API Provider Setup.

string

oauth.api.secret

OAuth 2.0 authentication only. The Client Secret from HubSpot CRM. This is the Client Secret that you noted in API Provider Setup.

Optional. Identifies that events are enabled for the element instance.Default: false

boolean

Event Typeevent.vendor.type

Optional. Identifies the type of events enabled for the instance, either webhook or polling.

string

Event Notification Callback URLevent.notification.callback.url

For webhooks and polling.The URL where your app can receive events.

string

Callback Notification Signature Keyevent.notification.signature.key

For webhooks and polling.OptionalA user-defined key for added security to show that events have not been tampered with. This can be any custom value that you want passed to the callback handler listening at the provided Event Notification Callback URL.

string

Objects to Monitor for Changesevent.objects

For webhooks and polling.OptionalComma separated list of objects to monitor for changes.

string

Event poller refresh interval (mins)event.poller.refresh_interval

For polling only.A number in minutes to identify how often the poller should check for changes.