Webhook Payload

After each instant outbound call attempt completes (connected or not), the system sends a POST request to the webhook URL you provided in webhook_config when creating the call. Use this to track call outcomes, sync agent-extracted data to your systems, and trigger downstream workflows.

Payload schema

string

required

Unique identifier for this call attempt. Matches the attempt_id returned in the Create Instant Outbound Call response.

string

required

Outcome of the call attempt. One of:

Value	Meaning
`connected`	Call was answered and a conversation took place
`no_answer`	The recipient did not pick up
`busy`	The recipient’s line was busy
`failed`	Call could not be placed (provider error, invalid number, etc.)

object

required

Information about the telephony channel used for the call.

Show channel_info properties

string

required

Type of communication channel. One of "v2v", "whatsapp"

string

required

Telephony provider used to place the call (e.g. "exotel", "twilio")

string

required

Phone number used by the agent for this call, in E.164 format

number | null

Call duration in seconds. null if the call did not connect.

string | null

Unique interaction ID for retrieving transcripts and recordings via the Analytics API. null if the call did not connect.

string | null

Human-readable reason for failure. Typically prefixed with the provider name (e.g. "exotel: Phone number is registered under TRAI NDNC"). null on successful or unanswered calls.

object | null

Agent variables at the end of the conversation, containing any data extracted or updated during the call. null if the call did not connect.

object | null

The webhook configuration that was passed when creating the call, echoed back for correlation.

Show webhook_config properties

string

required

The webhook URL the payload was delivered to

object | null

Custom metadata you attached to the webhook configuration. Useful for passing through external IDs or routing tags.

array | null

Transcript of the conversation as a list of turns. null if the call did not connect.

Show interaction_transcript item

string

required

Speaker role — "agent" or "user"

string

required

English text of the turn (translated if the conversation was in another language)

Examples

Connected call

{
  "attempt_id": "44b4f89d-252b-4585-ad2e-0ed5842cc6c5",
  "status": "connected",
  "channel_info": {
    "channel_type": "v2v",
    "channel_provider": "exotel",
    "agent_phone_number": "+91804XXXXXXX"
  },
  "duration": 16.83,
  "interaction_id": "20250920/1ae056a30013510b66a6a0",
  "failure_reason": null,
  "final_agent_variables": {
    "customer_name": "Amit",
    "disposition": "NA",
    "employment_type": "",
    "call_step": "IDENTITY VERIFIED",
    "tenure": "10 years",
    "business_property": "",
    "offer_id": "",
    "dialer_id": "NA",
    "product_name": "",
    "business_type": "",
    "years_active": "",
    "customer_interest": ""
  },
  "webhook_config": {
    "url": "https://your-server.example.com/webhook",
    "metadata": null
  },
  "interaction_transcript": [
    { "role": "agent", "en_text": "Hello, am I speaking with Amit?" },
    { "role": "user", "en_text": "Yes, this is Amit." },
    { "role": "agent", "en_text": "Great, I'm calling regarding your account. Could you confirm your date of birth for verification?" },
    { "role": "user", "en_text": "Sure, it's 15th March 1990." }
  ]
}

No answer

{
  "attempt_id": "df5b6536-5130-4a43-bc5d-6771d1f93355",
  "status": "no_answer",
  "channel_info": {
    "channel_type": "v2v",
    "channel_provider": "exotel",
    "agent_phone_number": "+91804XXXXXXX"
  },
  "duration": null,
  "interaction_id": null,
  "failure_reason": null,
  "final_agent_variables": null,
  "webhook_config": {
    "url": "https://your-server.example.com/webhook",
    "metadata": null
  },
  "interaction_transcript": null
}

Provider failure

{
  "attempt_id": "951e49d8-d9a5-45a9-aed4-c42366d29129",
  "status": "failed",
  "channel_info": {
    "channel_type": "v2v",
    "channel_provider": "exotel",
    "agent_phone_number": "+91804XXXXXXX"
  },
  "duration": null,
  "interaction_id": null,
  "failure_reason": "exotel: Phone number is registered under TRAI NDNC",
  "final_agent_variables": null,
  "webhook_config": {
    "url": "https://your-server.example.com/webhook",
    "metadata": null
  },
  "interaction_transcript": null
}

The webhook_config object is echoed back in every payload. If you passed custom metadata when creating the call, it will appear here — useful for correlating webhooks with your internal records.

Deployments

Campaigns

Instant Outbound

Analytics

BYOK (Bring Your Own Key) API

Payload schema

Examples

Connected call

No answer

Provider failure

​Payload schema

​Examples

​Connected call

​No answer

​Provider failure

Payload schema

Examples

Connected call

No answer

Provider failure