Rotate the signing secret

Replaces the signing secret and returns the new one once. Deliveries are signed with the new secret straight away, so update your server first or accept both secrets for a few minutes.

Scope: webhooks:manage.

POST /webhook/rotate-secret

Rotate the signing secret

cURL

curl --request POST \
  --url https://api.telleo.ai/v1/webhook/rotate-secret \
  --header 'X-API-Key: <api-key>'

200

Example

{
  "object": "webhook",
  "url": "<string>",
  "enabled": true,
  "events": [
    "call.completed",
    "call.not_connected"
  ],
  "secret": "whsec_3f9a…",
  "secret_hint": "whsec_…9c1d",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

Your AI calling API key (vak_call_…). Authorization: Bearer <key> also works.

Response

200

application/json

The webhook with its new secret.

object · string

Allowed value: "webhook"

url · string

enabled · boolean

events · string[]

Example:

["call.completed", "call.not_connected"]

secret · string

The signing secret. Returned only when the endpoint is first set and when the secret is rotated. Store it.

Example:

"whsec_3f9a…"

secret_hint · string

First and last characters of the secret, on reads.

Example:

"whsec_…9c1d"

created_at · string<date-time>

updated_at · string<date-time>