Replace an existing secret

Replace an existing webhook secret immediately or as part of rotation. This new secret will be used to verify all subsequent webhook request signature.

PUT /webhook_secrets

Replace an existing secret

cURL

curl --request PUT \
  --url https://api.synctera.com/v2/webhook_secrets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_rolling_secret": true
}
'

200

{
  "deleted_at": "2023-11-07T05:31:56Z",
  "secret": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

is_rolling_secret · boolean

Set true to let the current secret expire in the next 24 hours. Set false to let the current secret expire immediately.

Response

200

application/json

Webhook secret response

deleted_at · string<date-time>

Timestamp that the old secret is delete

secret · string

Generated secret. Do not share. This secret will be used to verify that webhook requests were sent from Synctera.

Required string length: 64