Set the webhook

Sets the one HTTPS endpoint that receives call.completed and call.not_connected. The first time, the response includes the signing secret; changing the URL later keeps the secret.

Scope: webhooks:manage.

PUT /webhook

Set the webhook

cURL

curl --request PUT \
  --url https://api.telleo.ai/v1/webhook \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "https://crm.example.com/telleo/webhook"
}
'

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.

Body

application/json

url · string<uri> · required

Example:

"https://crm.example.com/telleo/webhook"

Response

200

application/json

The webhook (with secret when it was just created).

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>