Webhooks

This guide shows how webhooks work in Contentful.

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 Settings → Webhooks 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.

webhook new webhook

Creating new webhook

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

webhook  events

Select when the webhook should be triggered

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.

webhook  list of webhooks

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.

webhook  activity log

See how your requests are doing

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

webhook  request details  super secret

Investigate the details

Further reading

Read our API documentation for specific implementation details.

Unlock the power of digital content
Build experiences that drive your business forward with the composable content platform.
add-circle arrow-right remove style-two-pin-marker subtract-circle remove