Syndai Docs

Rotate a webhook signing secret

POST
/api/v1/external/coding/webhooks/{endpoint_id}/rotate-secret

Mint a new signing secret for an endpoint and return it once; it is never returned again. The previous secret is retired after a 24-hour grace window (retired_grace_until), giving you time to move your receiver to the new one. An endpoint outside your workspace is a 404. Requires the coding:webhooks:write scope.

Authorization

CustomerApiKey
headerAuthorizationBearer <API Key>

Customer API key sent as a bearer token

Path Parameters

endpoint_id*string
Formatuuid

Query Parameters

customer_id?|null

Response Body

Document created, URL follows

application/json
  1. response
retired_grace_until*string
Formatdate-time
secret*string
Formatpassword
version*integer
Example Request
curl -X POST 'https://api.syndai.ai/api/v1/external/coding/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/rotate-secret'
Example Response
{  "retired_grace_until": "2019-08-24T14:15:22Z",  "secret": "pa$$word",  "version": 0}