Tizondocs
ReferenceWebhooks

Rotate a webhook endpoint secret

POST
/v1/webhook_endpoints/{webhook_endpoint_id}/rotate_secret

Issues a new signing secret and returns it once. Deliveries are signed with the new secret immediately, so deploy it before rotating.

Authorization

ApiKey
AuthorizationBearer <token>

An account API key, sent as Authorization: Bearer tz_live_…. The prefix selects the mode: tz_test_ for sandbox, tz_live_ for real money.

In: header

Path Parameters

webhook_endpoint_id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/webhook_endpoints/string/rotate_secret"
{  "id": "string",  "object": "webhook_endpoint",  "url": "string",  "description": "string",  "enabled_events": [    "string"  ],  "status": "active",  "disabled_reason": "string",  "secret": "string",  "last_success_at": "2019-08-24T14:15:22Z",  "last_failure_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}