WebhooksNotificationsEventsCallstarted
CallStarted webhook payload schema (documentation only)
⚠️ DO NOT CALL THIS ENDPOINT - it's for documentation only! This shows the structure of 'CallStarted' webhook payload that will be sent to your webhook URL.
Authorization
Bearer AuthorizationBearer <token>
JWT Authorization header using Bearer scheme
In: header
Response Body
application/json
curl -X POST "https://api.speaknode.com/api/webhooks/notifications/events/CallStarted"{
"event": "ConversationComplete",
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"direction": "Inbound",
"status": "Ringing",
"end_reason": "ClientHangup",
"error_message": "string",
"call_sid": "string",
"telecom_provider": "Twilio",
"from_number": "string",
"to_phone_number": "string",
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"agent_title": "string",
"phone_number_agent_id": "3111abc6-acae-4f9c-9be9-8979179075ad",
"telecom_account_id": "d63a8d2e-2b73-4bca-8e9b-df41d521bc3b",
"language_locale_id": "96776dbf-250a-49f2-a14d-7e906d335ad0",
"campaign_item_id": "78a8e446-a45f-4f73-8757-0093137dd224",
"requested_at": "2019-08-24T14:15:22Z",
"connected_at": "2019-08-24T14:15:22Z",
"answered_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"error_at": "2019-08-24T14:15:22Z",
"duration_seconds": 0,
"transfer_destination_number": "string",
"transfer_summary": "string",
"variables": [
{
"name": "string",
"value": null
}
],
"override_first_message": true,
"first_message": "string",
"override_system_prompt": true,
"system_prompt": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"agent_session_id": "24c466f0-a9f6-4ceb-b85d-adcff7fc7823",
"session": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"agent_title": "string",
"status": "Pending",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"duration_seconds": 0,
"error_message": "string",
"called_by_id": "d4a76b42-6d4d-4dd4-874e-ad84f407c441",
"called_by_name": "string",
"language_id": "e5383c4a-ba2f-4900-a483-8de374094cdf",
"locale_id": "50590343-6693-4a61-8470-c8115d9ddc18",
"language_locale_code": "string",
"live_kit_room_name": "string",
"live_kit_egress_id": "string",
"live_kit_dispatch_id": "string",
"live_kit_job_id": "string",
"transcription_path": "string",
"has_audio": true,
"telecom_provider": "Twilio",
"from_number": "string",
"to_number": "string",
"call_sid": "string",
"test_run_id": "01dbc221-8963-4bd7-8591-4a1f9d286862",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"test_status": "Initial",
"test_eval_result": {
"success": true,
"reasons": [
"string"
],
"completion_reason": "StepsExhausted"
},
"room_metadata": {
"failed": true,
"skip_composite_egress": true,
"error": "string",
"operator_invite": {
"call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e",
"end_reason": "ClientHangup",
"reason": "string"
},
"client_call": {
"call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e",
"end_reason": "ClientHangup",
"reason": "string"
}
},
"synthesized_user_tts_version_id": "3eef8062-114c-41ac-8f12-252145456b8d",
"synthesized_user_tts_voice_id": "1ad64ff6-07e8-427e-a354-8d650e0e1736",
"synthesized_user_tts_additional_properties": [
{
"name": "string",
"value": null
}
],
"synthesized_audio_path": "string",
"synthesized_hangfire_job_id": "string",
"session_token": "string",
"history": [
{
"role": "System",
"content": "string",
"kind": "Message",
"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"interrupted": true,
"metrics": {
"started_speaking_at": "2019-08-24T14:15:22Z",
"stopped_speaking_at": "2019-08-24T14:15:22Z",
"transcription_delay": 0,
"end_of_turn_delay": 0,
"on_user_turn_completed_delay": 0,
"llm_node_ttft": 0,
"tts_node_ttfb": 0,
"e2e_latency": 0,
"transcript_confidence": 0
},
"tool_name": "string",
"tool_call_id": "string",
"tool_arguments_json": "string",
"tool_output": "string",
"tool_is_error": true,
"handoff_to_agent_id": "string",
"instructions": "string",
"tools_added": [
"string"
],
"agent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string"
},
"llm_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"model": "string",
"gateway": "string",
"version": "string"
},
"stt_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"model": "string",
"gateway": "string",
"version": "string"
},
"tts_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"model": "string",
"gateway": "string",
"version": "string"
},
"vad_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"model": "string",
"gateway": "string",
"version": "string"
}
}
],
"audio_url": "string",
"audio_url_expires_at": "2019-08-24T14:15:22Z",
"agent_audio_url": "string",
"user_raw_audio_url": "string",
"user_cleaned_audio_url": "string",
"synthesized_audio_url": "string",
"synthesized_chat_history": [
{
"role": "System",
"content": "string",
"kind": "Message",
"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"interrupted": true,
"metrics": {
"started_speaking_at": "2019-08-24T14:15:22Z",
"stopped_speaking_at": "2019-08-24T14:15:22Z",
"transcription_delay": 0,
"end_of_turn_delay": 0,
"on_user_turn_completed_delay": 0,
"llm_node_ttft": 0,
"tts_node_ttfb": 0,
"e2e_latency": 0,
"transcript_confidence": 0
},
"tool_name": "string",
"tool_call_id": "string",
"tool_arguments_json": "string",
"tool_output": "string",
"tool_is_error": true,
"handoff_to_agent_id": "string",
"instructions": "string",
"tools_added": [
"string"
],
"agent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string"
},
"llm_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"model": "string",
"gateway": "string",
"version": "string"
},
"stt_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"model": "string",
"gateway": "string",
"version": "string"
},
"tts_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"model": "string",
"gateway": "string",
"version": "string"
},
"vad_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"model": "string",
"gateway": "string",
"version": "string"
}
}
],
"agent_joined_at": "2019-08-24T14:15:22Z",
"recording_started_at": "2019-08-24T14:15:22Z",
"campaign_item_id": "78a8e446-a45f-4f73-8757-0093137dd224",
"campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
"campaign_name": "string",
"url_parameters": {
"property1": "string",
"property2": "string"
},
"variables": [
{
"name": "string",
"value": null
}
]
}
}
}