About webhooks
Add a webhook URL to the request in order to receive information after the call.
Setting Up a Webhook
- Specify the Webhook URL: In your API request body, include the
external_webhook_url
key with the URL of your webhook receiver. - Test with the webhook: For development and testing purposes, you can use Webhook.site to simulate receiving webhook data.
API Request Example
Include the following key-value pair in your API request body:
Webhook Response Example
Upon completion of the call, the webhook URL will receive a response like the following:
Understanding the Call Object States
The call object in the webhook response contains a status field which can have various values, each indicating a different state of the phone call. Below is a table explaining these statuses:
End Call Reason
This end_call_reason parameter provides insight into the reason why a call ended: