ZapAPI Docs
Get StartedConceptsAI GatewayGuidesPayment GatewaySDKAPI ReferenceResources
ApiWebhooks

Roll (rotate) the webhook signing secret

POST
/api/v1/webhooks/{id}/roll-secret

Generates a NEW secret and invalidates the old one immediately. Update your server with the new secret — deliveries after rotation are signed with it.

Authorization

bearer

Path Parameters

id*string

Header Parameters

X-API-Version?string

API version for header-based versioning

Default"1"
Value in"1""2"

Response Body

Example Request
curl -X POST 'http://localhost:3001/api/v1/webhooks/string/roll-secret'
Example Response201
Empty

Reveal the webhook signing secret GET

Returns the webhook signing secret (for verifying deliveries with the SDK). Owner-only; the secret is select:false everywhere else.

Test webhook delivery POST

Next Page