Rotate the signing secret

POSThttps://api.checkslip.com/api/webhooks/endpoints/{endpoint_id}/secret/rotate

API key

Issues a new secret, shown only in this response. The old secret keeps working for 24 hours (see previous_secret_expires_at); meanwhile every message carries both signatures in the webhook-signature header, separated by a space, so you can switch your system to the new secret without missing a message. You cannot rotate again within those 24 hours (ROTATION_IN_PROGRESS). An Idempotency-Key is required. The account owner gets an email, which never contains the secret. Needs an API key with webhook:manage.

Parameters

FieldInTypeRequired
endpoint_idpathstringyes
traceparentheaderstringno
Idempotency-Keyheaderstringyes

Responses

200 application/json

FieldTypeRequired
secretstringyes
previous_secret_expires_atstring (date-time)yes

Possible errors

400401403404409422

An error as Problem Details. All codes are listed at Error codes