Skip to main content

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

EventDescription
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

ResultDescription
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

event
string
required
The event type. One of call.completed or call.failed.
data
object
required

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...\nProspect: Hi, yes I was expecting your call..."
  }
}