Create a webhook

Webhooks allows your app to easily receive notifications whenever there are updates to a chosen set of events. A typical example is when a publication is published, and the API is updated.

Create your webhook

To create a webhook, go to Settings > Developers > Webhooks and click ' Add webhook'. Fill in your endpoint URL. Please remember that webhook endpoints must start with https://.

Webhook triggers: events

There are different events that can trigger a webhook notification. You can choose publication, asset, or container events (such as created, changed, or deleted). For customer segmentation, there are person and segment events as well. Learn more about the event types on our developers portal.

Webhook triggers: models

When you have selected a publication event, you will receive notifications when a publication is created, (un)published, changed, or deleted. You can further specify which publications you want to receive notifications from. Select one or more publication models to receive webhook events for publications of that specific model. Selecting none will act as a wildcard.

Headers

There are some use-cases where an application requires some fields to be added in the header of the webhook payload. The most common headers are access tokens or a personal scope key. To add a custom header, enter a header key and value. 

Retry

Select the number of retries for an unfinished webhook. The default number is 35.

Switch off webhook

You can easily switch off your webhook temporarily. Go to the detail page of your webhook via Settings > Developer > Webhooks, and disable the 'status' option.

Delete your webhook

When you no longer need the webhook, you can delete the webhook permanently. Click the ' Delete' button on the detail page, or delete the webhook from the list view.