Webhooks
Receive RankDebug events at your own HTTPS endpoint, signed so you can trust them.
A webhook sends an HTTP POST to an endpoint of yours when something happens in a workspace, so you can route site health alerts into your own chat, incident or ticketing tools. Each webhook belongs to one workspace and subscribes to the events it wants.
Setting one up
Create webhooks on the Webhooks page of the dashboard or through the API. A webhook needs:
- an HTTPS URL on a public host,
- one or more events,
- a signing secret, which RankDebug generates if you do not provide one. It is shown once, when the webhook is created or the secret is rotated.
You can also add up to ten custom headers, for example a token your endpoint expects. Their values are stored encrypted and never shown again.
Send Test on a webhook delivers a webhook.test event to that endpoint alone, so you can check your receiver before a real event arrives.
What a delivery looks like
Every delivery is a JSON body with the event name, the event's data and when it was created:
{
"event": "site_check.regression",
"data": { },
"timestamp": "2026-10-09T07:04:12.512Z"
}And these headers:
| Header | Value |
|---|---|
Content-Type | application/json |
X-RankDebug-Event | The event name |
X-RankDebug-Delivery | An id shared by every attempt of this event, for deduplication |
X-RankDebug-Timestamp | When this attempt was sent, in Unix seconds |
X-RankDebug-Signature | sha256= and a signature over the body |
X-RankDebug-Signature-256 | sha256= and a signature over the timestamp and the body |
Verification shows how to check the signatures.
Responding
Answer with any 2xx status within 10 seconds. Anything else, a timeout or a connection error counts as a failure and is retried. Redirects are not followed, so point the webhook at the final URL.
Since an event can be delivered more than once, use X-RankDebug-Delivery to ignore repeats.
Related documentation
- Events
The events a webhook can subscribe to, when they fire, and what their data contains.
- Verification
Check that a webhook delivery came from RankDebug and has not been replayed.
- Retries and Deliveries
How failed deliveries are retried, when a webhook is paused, and how to inspect and replay deliveries.
- Webhooks
Create and manage webhook endpoints, send test events, and read and replay deliveries.