v2

latestOpenAPI 3.1.02026-08-07750280.6 KB

Webhooks

Create a webhook subscription

Supported events:
- `call.ended` — a call finished (status, duration, transcript reference)
- `call.summary_ready` — the AI summary for a call is available
- `appointment.booked` — a reservation was confirmed
- `appointment.updated` — a reservation was rescheduled or its status changed
- `appointment.cancelled` — a reservation was cancelled
- `contact.created` — a new contact was created

The response includes a one-time `secret`. Store it securely: every delivery
is signed with it via the `X-Webhook-Signature: sha256=<hmac>` header. The
secret is never retrievable again.

Authentication:
- API key with READ_WRITE permission

post/webhooks

Request body

webhook_urlstring required

HTTPS endpoint that will receive event deliveries.

eventsstring[] required

Event types to subscribe to. Valid values: call.ended, call.summary_ready, call.transcript_ready, appointment.booked, appointment.updated, appointment.cancelled, contact.created, order.created, order.status_changed, dialer.contact.completed, dialer.campaign.completed.

descriptionstring nullable

Optional human-readable label for this subscription.

Example request

{
  "description": "n8n production workflow",
  "events": [
    "call.ended",
    "appointment.booked"
  ],
  "webhook_url": "https://example.com/hooks/inbound"
}

Response

Subscription created

{"stackTrail":"paths:/webhooks:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown","title":"Response Create Webhook Webhooks Post"}