Rotate signing secret

POST

/api/webhooks/subscription/{id}/rotate-secret

Code sample: Shell / cURL

curl --request POST \
  --url https://api.ztlpay.io/api/webhooks/subscription/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rotate-secret \
  --header 'Authorization: Bearer <token>'

• Production environment
• Sandbox environment for testing

Already queued deliveries retain the previous signing secret. Allow an overlap period in your receiver while those deliveries finish.

Authorizations

• OAuth2Sandbox
  api://ac0d1aea-5e3a-463f-9dd1-194898ee5820/.default
• OAuth2Production
  api://1f115cad-5576-4db9-a7f9-8921c47a86e4/.default

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

New signing secret. Store it securely; it cannot be retrieved again.

Media typeapplication/json

object

id

required

string format: uuid

signingSecret

required

string

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "signingSecret": "example"
}

404

Subscription was not found.