Webhooks

A short introduction

Webhooks in Contentful help by responding to events such as "an entry was edited", and "an asset has been published/unpublished".

Whenever an event like this occurs, you can set up a webhook that will call a specified URI to somehow react. For instance, you can send a notification to a Slack channel every time someone edits an entry to be notified of changes.

Webhooks greatly extend the integration possibilities provided by Contentful.

Setup

Go to SettingsWebhooks from the navigation bar at the top. Click Add webhook, enter the credentials of the remote host and configure whatever else is necessary in your environment, and you're done.

{: .img} webhook  new webhook

{: .img-caption} Creating new webhook

{: .note} Note: You can fine-tune the events which call a webhook.

{: .img} webhook  events

{: .img-caption} Select when the webhook should be triggered

{: .note} Note: The "Save" webhook is triggered when the entry (or an asset) has been saved with an API call, and "Autosave" is triggered when it's autosaved in the UI.*

For specific details on what's included in the HTTP request, please refer to the API reference.

Overview

You can find all the webhooks you've created in the main Webhooks screen.

{: .img} webhook  list of webhooks

{: .note} Note: There's a per-space limit of 20 webhooks.

Activity log

To help you see how the webhooks are doing and make sure that they work as expected, Contentful shows the status of every webhook call in the activity log. Click on a webhook, and the activity log will appear.

{: .img} webhook  activity log

{: .img-caption} See how your requests are doing

To see the request details (including the complete JSON) and the remote server response, click View details.

{: .img} webhook  request details  super secret

{: .img-caption} Investigate the details

Further reading

Read our API documentation for specific implementation details.

Don't miss the latest

Get updates in your inbox
A monthly newsletter to help you build better digital experiences with Contentful.
add-circle remove subtract-circle