Webhooks
Trigger external workflows when content or users change in the Online CMS Editor.
Webhooks let the Online CMS Editor notify another service when content or users change. Use them to trigger a deployment, send a team notification, update a search index, start an automation, or connect the CMS to another part of your workflow.
Webhooks are available with paid plans and are managed by owners in the Online CMS Editor.
Add a webhook
Sign in to the Online CMS Editor as an owner.
Open Webhooks.
Click Add Webhook.
Enter the endpoint URL that should receive webhook requests.
Choose the events this endpoint should receive.
Click Create Webhook.
Copy the signing secret immediately and store it somewhere safe.
Webhook endpoint URLs must use HTTPS. The signing secret is only shown when the webhook is created.
Choose events
Each webhook can listen for one or more events:
file.created
A content file is created.
file.updated
A content file is updated, renamed, or restored from version history.
file.deleted
A content file is deleted.
user.created
A user account is created.
user.updated
A user account is updated.
user.deleted
A user account is deleted.
Only selected events are sent to the endpoint.
Receive webhook requests
When an event fires, the Online CMS Editor sends a JSON POST request to the endpoint URL.
Example payload:
File events include the content filename and folder index. User events include the user email, and user.created also includes the role.
Webhook requests include these headers:
The signature is an HMAC-SHA256 hash of the raw JSON request body using the webhook signing secret. Verify the signature before trusting the request.
Manage webhooks
From the Webhooks page, you can:
Enable or disable a webhook without deleting it.
Edit the endpoint URL.
Change the selected events.
Delete a webhook.
Review recent delivery attempts in the delivery log.
Clear the delivery log.
Delivery log
Each delivery is attempted once. The delivery log shows recent attempts with the event, endpoint URL, HTTP status, success or error state, and any connection error.
If an endpoint returns a non-2xx response or cannot be reached, the delivery is marked as an error. Webhooks are not retried automatically, so your receiving endpoint should handle duplicate or missed events safely.
Last updated
Was this helpful?

