POST /v3/callbacks/endpoints/{id}/rotate-secret
Rotate the endpoint's signing secret. A new signing secret for the endpoint, answered once with the endpoint. The previous secret still signs beside it for expire_previous_in_s seconds (default 86400; 0: not at all). The body is optional. 503 callbacks_unavailable while this server has no callback key file or its database lacks the callback tables.
API key: required. See Authentication.
Group: Webhooks (API: callbacks)
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
id | path | string | yes | The endpoint's id (cbe_ and 24 hex digits). |
Request body
A CallbackRotateSecret object, as JSON.
| Field | Type | Required | Description |
|---|---|---|---|
expire_previous_in_s | integer | no | How long the previous secret still signs beside the new one; 0: not at all. |
Responses
| Status | Body | Description |
|---|---|---|
200 | CallbackEndpointCreated (application/json) | OK |
400 | Problem (application/problem+json) | Invalid or unknown parameter, or a body that is not one JSON document (code invalid_body). |
401 | Problem (application/problem+json) | Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728). |
403 | Problem (application/problem+json) | The credential's scope does not cover this route (code forbidden), or the organization's plan has no callbacks (code plan_required). |
404 | Problem (application/problem+json) | Not found. |
415 | Problem (application/problem+json) | The body is not sent as Content-Type: application/json (code unsupported_media_type). |
503 | Problem (application/problem+json) | Callbacks are not available: this server has no callback key file or its database lacks the callback tables (code callbacks_unavailable); too many callback URLs are being checked at once (code db_unavailable, reason resolver_busy, Retry-After 1); or the database is unavailable (code db_unavailable). |
default | Problem (application/problem+json) | Any other error (405, 500, 504). |
Response body
A 200 carries a CallbackEndpointCreated object.
| Field | Type | Required | Description |
|---|---|---|---|
active | boolean | yes | |
created_at | date-time (RFC 3339, UTC) | yes | |
description | string | null | yes | |
event_types | array of string | yes | |
health | object | yes | |
health.consecutive_failures | integer | no | |
health.disabled_at | date-time (RFC 3339, UTC) | null | no | |
health.disabled_reason | string | null | no | |
health.failing_since | date-time (RFC 3339, UTC) | null | no | |
health.last_success_at | date-time (RFC 3339, UTC) | null | no | |
health.state | string | yes | One of: unverified, active, failing, disabled. |
health.verified_at | date-time (RFC 3339, UTC) | null | no | |
id | string | yes | cbe_ and 24 hex digits. |
last_24h | object | yes | Deliveries of the last 24 hours by state. |
last_24h.delivered | integer | no | |
last_24h.dropped | integer | no | |
last_24h.failed | integer | no | |
last_24h.held | integer | no | |
updated_at | date-time (RFC 3339, UTC) | yes | |
url | string | yes | As stored: https, the host in lower case, no :443, / for an empty path. |
secret | string | yes | whsec_ and the standard base64 (with padding) of 32 random bytes: the Standard Webhooks signing secret. Shown only in this answer. |
Example request
curl -sS -X POST -H "Authorization: Bearer $SECBLAST_API_KEY" \
-H "Content-Type: application/json" -d @body.json \
'https://api.secblast.com/v3/callbacks/endpoints/cbe_0123456789abcdef01234567/rotate-secret'More in Webhooks (API: callbacks)
Previous: POST /v3/callbacks/endpoints/{id}/replay · Next: POST /v3/callbacks/endpoints/{id}/test
Markdown version: /docs/reference/post-callbacks-endpoints-id-rotate-secret.md