webhooks

Rotate the signing secret

Creates a new signing secret and returns it. Unless immediate is true, the replaced secret keeps signing alongside the new one for 24 hours, until previous_secret_expires_at, so you can switch your receiver without rejecting deliveries.

Only the replaced secret is affected: a secret from an earlier rotation keeps its own 24-hour expiry, even with immediate: true. To stop every earlier secret now, delete the webhook and add it again.

If the response is lost, read the webhook before repeating: a new secret_rotated_at means the rotation happened, and retrieving the secret gives you the new one.

post/v1/webhooks/{webhook_id}/secret/rotate

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/webhooks/{webhook_id}/secret/rotate
  • Auth: HTTP bearer

Path parameters

webhook_idstring required

Cherami resource ID returned by the API.

Request body

immediateboolean

true stops the replaced secret at once.

Response

Success.

idstring required

Cherami resource ID.

secretstring required

Signing secret for Standard Webhooks verification (whsec_...). Returned only on creation, retrieval and rotation.

secret_rotated_atstring date-time required

UTC timestamp with milliseconds.

previous_secret_expires_atstring date-time required

UTC timestamp with milliseconds.

Changes

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