Rotate the secret

Replace a webhook's signing secret.

POSThttps://api.raims.com/v1/webhooks/{webhook_id}/rotate_secret

Request a new secret for the same registration and update the receiver. Keep the returned value in a secrets vault; configuration queries cannot retrieve it. The transition period lets you update the receiver before sends start using only the new secret. If exposure is suspected, use grace_period_seconds: 0 to replace the secret immediately, even while a transition is in progress.

See Rotate the secret to choose the transition period and validate signatures during the change.

Path Params

webhook_idstringrequired

Webhook identifier received at creation or in the list.

Up to 26 characters

Body Params

grace_period_secondsintegeroptional

Period during which the previous secret may continue signing deliveries. Zero generates a new signature and ends the validity of previous secrets, including during an active transition. Requests already authorized or in progress may arrive with the previous signature.

From 0 to 86400

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request POST \
  --url https://api.raims.com/v1/webhooks/%7Bwebhook_id%7D/rotate_secret \
  --header 'accept: application/json'

Response

Click Try it to send a request and see the response here. Or choose an example:

application/json

Rotate the secret

Path Params

Body Params

Responses

200OK

400Bad Request

404Not Found