Webhooks and Notifications

๐Ÿ“˜

Check out the webhooks dashboard

You can view, edit and troubleshoot all your webhooks from the webhooks dashboard in your developer tools .

You can use webhooks to receive notifications, such as conversation replies, and users being created. Notifications are grouped into topics which can be subscribed to.

The main concepts for the webhook API are subscriptions, topics, notifications and services.

Subscriptions

A Webhook subscription lets you register a URL which will have notifications posted to it. A webhook can be created via the API as described in the section โ€œCreate a Subscriptionโ€, or through your dashboard in the developer hub. Subscriptions can request notifications are sent with a signed verification. Each subscription also has a set of activity feeds described in โ€œSubscription Feedsโ€

Topics

A subscription will contain one or more topics. Topics can also have a sub topic - for example the topic user.created has a main topic of user and subtopic of created. Subscribing to a main topic will subscribe the webhook to all its sub-topics.

Notifications

The object delivered to a webhook is a notification. Notifications have payloads, which contain the APIโ€™s existing JSON objects, such as user or conversations.

Services

Services allow you to have notifications sent to another service or application, such as Slack or Hipchat, with the notification formatted for that service. Services are configured and managed via your Appโ€™s settings in Intercom, or through the service providerโ€™s settings.

The API currently only accepts subscriptions for the web service type, for general webhooks. You can see the available services here. Please note that some services may only provide a subset of the topics described here.