Webhooks

Rotate a webhook's signing secret

Generates a new signing secret and returns it once. The previous secret stops signing at once. Every delivery attempt, retries included, is signed with the secret the endpoint holds at that moment, so return a non-2xx for a signature you cannot verify and the retry arrives signed with the new secret.

Requires webhooks:m.

post/v1/webhooks/{id}/rotate-secret

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/webhooks/{id}/rotate-secret
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Response

The new secret, shown only here. The previous secret stops signing at once; retries of anything the endpoint rejects during the switch are re-signed with this one.

idstring required
signing_secretstring required

64 hex characters.

secret_rotated_atstring date-time required
noticestring required

Changes

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