Overview
Webhooks allow you to receive real-time notifications when events occur in your Cozmo AI account. Configure your webhook endpoint in your dashboard to start receiving events.
Events
Event Description call.completedFired when a call finishes successfully or is analyzed call.failedFired when a call fails due to technical or validation issues
Call Result Types
Result Description FINISHEDSuccessfully completed call FAILEDTechnical failure FAILED_VALIDATIONValidation error FAILED_SIPSIP/trunk error ANALYSIS_FAILEDPost-call analysis failed NO_ANSWERNo pickup BUSYLine was busy CANCELLEDCancelled
Payload Structure
The event type. One of call.completed or call.failed.
Unique identifier for the call.
Number of campaign attempts.
Whether the prospect requested to be added to the Do Not Call list.
Post-call evaluation results. Evaluation key (e.g., SENTIMENT, SUMMARY, CALLBACK_REQUESTED).
The extracted value from the evaluation.
Reasoning behind the evaluation result.
Boolean result of the evaluation.
Prospect information. Unique identifier for the prospect.
External identifier for integration purposes.
Full name of the prospect.
Email address of the prospect.
Phone number of the prospect.
Current status of the prospect.
ISO 8601 timestamp of prospect creation.
URL to the call recording (if available).
Overall sentiment of the call (e.g., positive, neutral, negative).
AI-generated summary of the call.
Full transcript of the call.
Example Payload
{
"event" : "call.completed" ,
"data" : {
"call_id" : "17546d2d-4939-4a86-b822-e497c70d5819" ,
"call_result" : "FINISHED" ,
"campaign_count" : 1 ,
"dnc_requested" : false ,
"evaluations" : [
{
"key" : "SENTIMENT" ,
"extracted_value" : "neutral" ,
"reasoning" : "The prospect maintained a neutral tone throughout the conversation." ,
"result_boolean" : true
},
{
"key" : "SUMMARY" ,
"extracted_value" : "The call covered product pricing and availability." ,
"reasoning" : "The conversation focused on product information." ,
"result_boolean" : true
},
{
"key" : "CALLBACK_REQUESTED" ,
"extracted_value" : "" ,
"reasoning" : "The prospect did not request a callback." ,
"result_boolean" : false
}
],
"extras" : null ,
"prospect" : {
"ID" : "5abb08f3-c2d7-44c1-9fb0-8bb7bb4aa66e" ,
"ExternalId" : "ext-123" ,
"FullName" : "Test User" ,
"Email" : "[email protected] " ,
"Phone" : "+971555555555" ,
"Status" : "new" ,
"ExtraMetadata" : {
"nickname" : "testttt"
},
"CreatedAt" : "2026-01-20T11:33:36.907871Z"
},
"recording_url" : "https://storage.example.com/recordings/17546d2d.mp3" ,
"sentiment" : "neutral" ,
"summary" : "The call discussed product pricing and the prospect showed interest." ,
"transcript" : "Agent: Hello, this is Cozmo AI calling... \n Prospect: Hi, yes I was expecting your call..."
}
}