Skip to main content

Introduction

Webhooks allow you to integrate external services with Codex. With webhooks you can send the content created in Codex through Rest API calls to external APIs on any event, such as create, save, auto save, publish, schedule etc.

How does it work?​

You can configure Codex webhooks through the Codex admin interface. You can create different types of Webhooks:

  1. Content - webhooks for events related to entries
  2. Lists - webhooks for events related to entry lists
  3. Media - webhooks for events related to assets
  4. Author - webhooks for events related to authors
  5. Section - webhooks for events related to sections
  6. Url - webhooks for events related to URLs in entries and sections
  7. Tag - webhooks for events related to tags
  8. Label - webhooks for events related to entry labels
  9. Job - webhooks for events related to jobs

How to set up your webhook?​

First you need an endpoint which will receive codex webhooks events, then select all the events you need to monitor and finally test your webhook endpoint functionality by clicking on the Test webhook button. Each webhook type has its own filters, so that only the events that occure in each specific set of filters are included in this webhook.

Event failures​

When a request is unsuccessful, Codex attempts to deliver the given event up to 3 times with an exponential backoff. You can view automatic requests in the Admin dashboard underneath the main failed request. You can also manually retry delivering the event by clicking in the Retry button. If the manual request is not successful, we will perform three automatic retries over the course of the following three days.

Email Notifications​

After reaching a total of 10 failures, an email notification is send to the user who integrated the webhook informing them about the failures. After reaching 10% of the total failures an email emphasizing the need for urgent action will be send to the creator, if the endpoint is not updated and delivery fails are not fixed or improved, after one week Codex will automatically disable the webhook.