Webhooks
Create a webhook endpoint
Register a public HTTPS destination for selected delivery events.
POST
/webhooksOn this page
Authentication
Send a RouteKite API key as a Bearer token. This endpoint requires the webhook:manage scope.
| Name | Type | Requirement | Description |
|---|---|---|---|
Authorization | string | Required | Bearer API key with the required workspace scope.Example: Bearer rk_your_key |
Request body
| Name | Type | Requirement | Description |
|---|---|---|---|
url | https URL | Required | A public HTTPS endpoint on port 443. |
description | string | Optional | A short label, up to 160 characters. |
events | event[] | Required | One or more unique email delivery event names. |
Response
| Name | Type | Requirement | Description |
|---|---|---|---|
id | uuid | Always | Endpoint ID. |
signing_secret | string | Creation only | Secret used to verify signed requests. |
Signing secret
The creation response includes the endpoint signing secret. Store it only in your server environment and use it to verify every request.
Errors
| Status | Code | What it means | What to do |
|---|---|---|---|
| 400 | INVALID_REQUEST | The endpoint input or identifier is invalid. | Correct the reported field. |
| 401 | UNAUTHORIZED | The API key is invalid. | Check the Bearer header. |
| 403 | FORBIDDEN | The key lacks webhook:manage access. | Use a key with the required scope. |
| 404 | WEBHOOK_NOT_FOUND | The endpoint is unavailable in this workspace. | Check the endpoint ID and workspace. |
| 409 | WEBHOOK_ALREADY_EXISTS | The destination is already registered. | Use the existing endpoint or delete it first. |
| 422 | INVALID_WEBHOOK_URL | The destination is not a public HTTPS endpoint. | Use a public HTTPS URL on port 443. |
| 429 | RATE_LIMITED | Too many requests were sent in a short period. | Honor Retry-After before retrying. |
| 500 / 503 | INTERNAL_ERROR | The operation could not complete. | Retry after a short delay. |