Skip to main content
POST
Rotate a signing secret
  • Credential: an account API key. A trial key returns 401 unauthorized.
  • Line-scoped keys: the list of a line-scoped key is not applied here: the key rotates the secret of any subscription of the account.
  • Idempotency-Key: not honored. A second call replaces the secret again. If you lose the response, rotate again.
  • Events: none. No event announces the rotation.
  • Secret: the response contains the signing secret: do not log it. No other operation returns it.
  • Guide: Secret rotation. The rotation takes effect immediately: every request sent after it is signed with the new secret only. old_secret_expires_at is the time of the rotation plus 5 minutes, and it has no effect on what iSnap sends.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

id
string
required

Id of the webhook subscription, as returned in id by POST /v1/webhooks: wh_ followed by 25 letters or digits.

Pattern: ^wh_[0-9A-Za-z]{25}$
Example:

"wh_3Kp8Rn9Fh2Lm5Qx7Vw1Yz4Bc6"

Response

The new signing secret.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

The result of the rotation of a signing secret.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.