v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Webhook Endpoint

Rotate Operational Webhook Endpoint Secret

Rotates an operational webhook endpoint's signing secret.

The previous secret will remain valid for the next 24 hours.

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

Path parameters

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

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