All pages

Docs

Setting up webhook endpoints

How to register webhook endpoints in the dashboard to send call events (started, ended, transcript, summary and more) to your systems, and check delivery logs.

View as Markdown

Webhooks send conversation events to the URLs you register. Webhooks in the left menu manages the current environment's endpoints. It opens for the developer role and above; viewers see only an explanation.

Event Sent when
call.started The call starts
call.handoff_requested The call is transferred to staff
call.ended The call ends
call.transcript_ready The transcript is ready
call.summary_ready The summary is ready
call.recording_ready The recording is saved

For the payloads and signature verification, see Results.

Register an endpoint#

The Webhooks page shows the webhook settings page inside it.

  1. Add an endpoint and enter the URL that receives events.
  2. Choose the events to receive.
  3. Save.
  4. Check the endpoint's signing secret and use it on your server to verify signatures.

The same page also lets you set payload transformations and check and resend deliveries.

Page expiry#

The webhook settings page stays usable for 15 minutes after it opens. After that, press Reload at the top right.

Delivery status per conversation#

Under Webhook deliveries in a conversation's details in the Call log, each event sent for that conversation shows its status (Success, Retrying, Failed and so on). If any endpoint failed, it shows "Failed". "No endpoint" means there is no endpoint, or none receives that event.

The live and test environments have separate endpoints.