Webhooks

Rotate a webhook signing secret

A new signing secret, in the answer and only there. For 24 hours each delivery carries two signatures in webhook-signature, one with each secret, so the receiver can switch without losing any; then only the new one.

post/webhooks/{id}/rotate-secret

Request

  • Base URL
    https://api.rizamo.com/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

The webhook endpoint's id (wh_).

Headers

Idempotency-Keystring

1 to 255 printable characters, new for each request (a UUID); the body up to 1 MB. For 24 hours a repeat with the same key, path and body gets the first answer, with Idempotent-Replayed: true, instead of running again; 5xx, 409 and 429 answers are not kept. Errors, Retries, has the rest.

Response

OK

secretstring required

The signing secret (whsec_ and base64), shown only now: keep it where your receiver reads it. Each delivery's webhook-signature is v1, and the base64 HMAC-SHA256, keyed with the base64 after whsec_, of <webhook-id>.<webhook-timestamp>.<body>.

Changes

No recorded changes to this operation across all 1 revision of this API.