Webhooks

What are webhooks?

The webhooks are used to notify you when content has been changed. Specify a URL, configure your webhook, and we will send an HTTP POST request whenever something happens to your content.

How do I configure a webhook?

Go to Settings → Webhooks from the navigation bar at the top. From there, hit Add webhook, and you will be directed to your new webhook.

Then choose a name, put in the information of your HTTP endpoint (URL and authentication), specify any custom headers and select the types of events that should trigger the webhook. You can also specify filters for more fine control.

What are the IP ranges for webhook calls?

The webhook system is hosted in AWS us-east-1 region.

The IP ranges are provided in the following link:

http://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html

If I received a publish event, why do I get an old version in the CDA?

As the delivery API is powered by a CDN network consisting of hundreds of servers distributed across continents, it takes some time (up to a few minutes) to reflect the changes to the published content.

This must be taken into consideration when reacting to webhooks. In normal conditions, there could be a reasonable delay of 2 to 5 minutes.

Why has the URL of my webhook been rejected?

When creating a new webhook, the URL field will reject:

• Private IPs (10.x, 192.x, etc.)
• Localhost
• Hostnames without a Top Level Domain
• URLs that resolve to localhost or redirects

What type of event will trigger my webhook?

While creating your webhook, you will be asked to choose what type of events should trigger it. Events are separated by the type of entity (Content Type, Entry and Asset) and the underlying action (Create, Save, Autosave, etc). For example, you can create a webhook that will be triggered whenever an Entry is Unpublished.

For even more fine control have a look at webhook filters.

Is it possible to filter webhooks based on environment or entity IDs?

Yes, webhooks have a filter property which can be used to filter webhooks based on properties of the entity that triggered the webhook. It is possible to filter on:

• entity ID e.g. sys.id
• environement ID e.g. sys.environment.sys.id
• content type ID e.g. sys.contentType.sys.id (for entries only)

For more information see: Webhook filters.