SVsvix
Webhook Endpoint

Rotate Operational Webhook Endpoint Secret

Changed on

Rotates an operational webhook endpoint's signing secret.

The previous secret will remain valid for the specified grace period (default 24 hours).

post/api/v1/operational-webhook/endpoint/{endpoint_id}/secret/rotate

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/operational-webhook/endpoint/{endpoint_id}/secret/rotate
  • Auth
    HTTP bearer

Path parameters

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

Headers

idempotency-keystring

The request's idempotency key

Request body

gracePeriodSecondsinteger nullable

How long the old secret will be valid for, in seconds.

Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.

keystring nullable

The endpoint's verification secret.

Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.

Example request

{
  "key": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
}

Response

no content

Changes