DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Subscription Model

Subscriptions are how you can set up webhook notifications for your App.

Subscription Object

Example Subscription Object

{
  "type": "notification_subscription",
  "id": "nsub_6ab4c480-fd8b-11e3-958f-c779cae3e1b3",
  "created_at": 1392731331,
  "updated_at": 1392731331,
  "service_type": "web",
  "topics": ["company", "conversation.user.created"],
  "url": "https://example.org/hooks/1",
  "active": true,
  "hub_secret": "7fa38fa4e7120189f631a6769dd4876b"
}

A subscription object contains the following fields -

Attribute

Type

Description

type

string

value is 'notification_subscription'

id

string

The Intercom defined id representing the subscription.

created_at

timestamp

The time the subscription was added to Intercom

updated_at

timestamp

The last time the subscription was updated

url

string

The url the notification should be sent to. Required depending on the service type.

service_type

string

The type of the service being called. Default is web for a plain webhook, which is the only accepted value currently.

topics

array

An array of topics to subscribe to.

active

boolean

Indicates whether the subscription is currently active.

hub_secret

string

Optional key used to sign notifications.

metadata

object

Required for event.created webhooks.