Call Events
call.started
Triggered when a call connects. Example Payload:{
"agent_id": "664f1a2b3c4d5e6f7a8b9c0d",
"event": "call.started",
"event_id": "evt_a1b2c3d4e5f67890abcdef12",
"timestamp": "2026-04-08T10:30:00.000000",
"conversation_id": "conv_abc123",
"agent_name": "Sales Bot",
"workspace_id": "ws_xyz789",
"to_number": "+14155551234",
"from_number": "+14155559876",
"call_type": "outbound",
"username": "Jane Doe",
"campaign_id": "camp_001",
"context_data": {
"crm_id": "CRM-9988"
},
"connected_at": "2026-04-08T10:30:00.000000"
}
call.completed
Triggered immediately when a call ends. Example Payload:{
"agent_id": "664f1a2b3c4d5e6f7a8b9c0d",
"event": "call.completed",
"event_id": "evt_b2c3d4e5f6789012bcdef123",
"timestamp": "2026-04-08T10:35:00.000000",
"conversation_id": "conv_abc123",
"agent_name": "Sales Bot",
"workspace_id": "ws_xyz789",
"to_number": "+14155551234",
"from_number": "+14155559876",
"call_type": "outbound",
"username": "Jane Doe",
"campaign_id": "camp_001",
"context_data": {
"crm_id": "CRM-9988"
},
"status": "completed",
"call_duration": 300,
"connected_at": "2026-04-08T10:30:00.000000",
"ended_at": "2026-04-08T10:35:00.000000",
"error_code": null,
"error_reason": null
}
call.processed
Triggered once post-call processing is complete (transcripts, credits, and recording are ready). Example Payload:{
"agent_id": "664f1a2b3c4d5e6f7a8b9c0d",
"event": "call.processed",
"event_id": "evt_c3d4e5f678901234cdef1234",
"timestamp": "2026-04-08T10:36:00.000000",
"conversation_id": "conv_abc123",
"agent_name": "Sales Bot",
"workspace_id": "ws_xyz789",
"to_number": "+14155551234",
"from_number": "+14155559876",
"call_type": "outbound",
"username": "Jane Doe",
"campaign_id": "camp_001",
"context_data": {
"crm_id": "CRM-9988"
},
"status": "completed",
"duration": 300,
"credits": 5,
"recording_url": "https://cdn.example.com/recordings/conv_abc123.mp3",
"call_insights": {
"appointment_booked": "yes",
"preferred_time": "morning"
},
"transcripts": [
{
"role": "assistant",
"content": "Hello, how can I help you?"
},
{
"role": "user",
"content": "I'd like to book an appointment."
}
],
"error_code": null,
"error_reason": null
}
call.recording
Triggered when a call recording upload completes. Example Payload:{
"agent_id": "664f1a2b3c4d5e6f7a8b9c0d",
"event": "call.recording",
"event_id": "evt_f6789012345678901234567f",
"timestamp": "2026-04-08T10:36:30.000000",
"conversation_id": "conv_abc123",
"recording_url": "https://cdn.example.com/recordings/conv_abc123.mp3",
"connected_at": "2026-04-08T10:30:00.000000",
"ended_at": "2026-04-08T10:35:00.000000",
"campaign_id": "camp_001"
}
Campaign Events
campaign.started
Triggered when a campaign becomes active. Example Payload:{
"agent_id": "664f1a2b3c4d5e6f7a8b9c0d",
"event": "campaign.started",
"event_id": "evt_d4e5f6789012345def123456",
"timestamp": "2026-04-08T09:00:00.000000",
"campaign_uid": "6640001122334455aabbccdd",
"campaign_id": "camp_summer_2026",
"campaign_name": "Summer Outreach",
"user_id": "690888213d71b7f1b3fad7de",
"workspace_id": "ws_xyz789",
"total_contacts": 500,
"status": "active",
"created_at": "2026-04-01T08:00:00.000000",
"scheduled_at": "2026-04-01T09:00:00.000000",
"started_at": "2026-04-01T09:00:00.000000"
}
campaign.ended
Triggered when a campaign finishes. Delivery is deferred until all successful-call credits are consumed. Example Payload:{
"agent_id": "69a2e792c92f9bd32b772133",
"event": "campaign.ended",
"event_id": "evt_6959f3b553cb4a06888ce983411357f3",
"timestamp": "2026-04-08T06:28:15.066239",
"campaign_uid": "69d5f559a234afec1ecba4cd",
"campaign_id": "camp_397d967d",
"campaign_name": "test4",
"user_id": "690888213d71b7f1b3fad7de",
"workspace_id": "690888213d71b7f1b3fad7df",
"total_contacts": 2,
"created_at": "2026-04-01T08:00:00.000000",
"scheduled_at": "2026-04-01T09:00:00.000000",
"total_calls": 2,
"successful_calls": 2,
"failed_calls": 0,
"started_at": "2026-04-01T09:00:00:000000",
"ended_at": "2026-04-01T09:03:14.980000",
"total_duration": "00:00:16",
"billable_duration": "00:02:00",
"total_credits": 2,
"status": "completed"
}