Intercom 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 polling and webhook events for Intercom. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance.

Polling

You can set up polling for the events resource. You can also copy the events configuration to poll other resources. See Configure Polling Through API for more information.

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

Use the /instances endpoint to authenticate with Intercom and create an element instance with polling enabled.

To authenticate an element instance with polling:

1. Construct a JSON body as shown below (see Parameters):

   {
     "element": {
       "key": "intercom"
     },
     "providerData": {
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration": {
       "oauth.api.key": "xxxxxxxxxxxxxxxxxxxx",
       "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxx",
       "oauth.callback.url": "https://xxxxxxxxxxxxxxxx/oauth",
       "oauth.user.refresher_time": null,
       "oauth.user.refresher_token": null,
       "event.notification.enabled": true,
       "event.poller.refresh_interval": "15",
       "event.vendor.type": "polling",
       "filter.response.nulls": "true",
       "event.poller.configuration": {
         "conversations": {
           "url": "/hubs/marketing/conversations?orderBy=updated_at desc",
           "idField": "id",
           "datesConfiguration": {
             "updatedDateField": "updated_at",
             "updatedDateFormat": "timestamp",
             "updatedDateTimezone": "GMT",
             "createdDateField": "created_at",
             "createdDateFormat": "timestamp",
             "createdDateTimezone": "GMT"
           }
         }
       }
     },
     "tags": [
       "<ADD_YOUR_TAG>"
     ],
     "name": "<INSTANCE_NAME>"
   }

2. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL with Polling

curl -X POST \
https://api.cloud-elements.com/elements/api-v2/instances \
-H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
-H 'content-type: application/json' \
-d '{
  "element": {
    "key": "intercom"
  },
  "providerData": {
    "code": "oiu3gr1g2roi12ruioiu190f9"
  },
  "configuration": {
    "oauth.api.key": "xxxxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxx",
    "oauth.callback.url": "https://mycoolapp.com/oauth",
    "event.notification.enabled": true,
    "event.poller.refresh_interval": "15",
    "event.vendor.type": "polling",
    "filter.response.nulls": "true",
    "event.poller.configuration": {
      "conversations": {
        "url": "/hubs/marketing/conversations?orderBy=updated_at desc",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated_at",
          "updatedDateFormat": "timestamp",
          "updatedDateTimezone": "GMT",
          "createdDateField": "created_at",
          "createdDateFormat": "timestamp",
          "createdDateTimezone": "GMT"
        }
      }
    }
  },
  "tags": [
    "Marketing"
  ],
  "name": "API Instance with Polling"
}

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 Intercom. 

Set Up Webhooks

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

1. Via a web browser, sign in to your Intercom developer account at https://app.intercom.com.
2. In the developer app dashboard, select the app that you'd like to send webhooks for.
3. Select Webhooks from the navigation items displayed on the left.
   The Webhooks page appears, where you see a field to enter your request endpoint URL. 
4. In order to enter this URL, create an instance of the Intercom element. While creating an instance, enable Events under Events Configuration and select Webhook as the Event Type. 
5. Click Create Instance.
6. Choose an account through which you'd like to create an instance.
7. You're now taken back to Cloud Elements. Select Instances on the navigation pane on your left and edit your instance.
8. You will see a field named Webhook URL. Copy the URL in that field.
9. Back on the Intercom page, click Edit, 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 selecting Webhook Topics according to your needs. Webhook Topics are types of notifications that your app can subscribe to.
11. Click Edit on the top right corner and select topic/s to configure the subscription/s as shown below.
    

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

Use the /instances endpoint to authenticate with Intercom and create an element instance with webhooks enabled.

To authenticate an element instance with webhooks:

1. Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.

2. Construct a JSON body as shown below (see Parameters):

   {
     "element": {
       "key": "intercom"
     },
     "providerData": {
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration": {
       "oauth.api.key": "<Intercom API key>",
       "oauth.api.secret": "<Intercom API secret>",
       "oauth.callback.url": "<Intercom Authorization callback URL >",
       "event.notification.enabled": true,
       "event.vendor.type": "webhooks",
       "event.notification.callback.url": "<CALLBACK_URL>",
       "event.notification.signature.key": "<OPTIONAL_SIGNATURE_KEY>"
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "name": "<INSTANCE_NAME>"
   }
   

3. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.

4. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
 https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "intercom"
  },
  "providerData": {
    "code": "xoz8AFqScK2ngM04kSSM"
  },
  "configuration": {
    "oauth.api.key": "Rand0MAP1-key",
    "oauth.api.secret": "fak3AP1-s3Cr3t",
    "oauth.callback.url": "https://mycoolapp.com",
    "event.notification.enabled": true,
    "event.vendor.type": "webhooks",
    "event.notification.callback.url": "https://mycoolapp.com/events",
    "event.notification.signature.key": "xxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Marketing"
  ],
  "name": "API Instance"
}'

Parameters

API parameters are in code formatting.