Skip to main content

Supported Events

Following events are supported by the Webhooks API.

call.status​

Triggered whenever a call's status changes throughout it's lifecycle. Possible values are:

  1. Outbound call initiated
  2. Inbound call initiated
  3. Call answered
  4. Call completed

Sample Payload​

{
    "event": "call.status",
    "call_id": string,
    "start_time": timestamp,
    "call_creator":string,
    "candidate_number": string,
    "virtual_number": string,
    "call_status": string,
    "call_type" : string,
    "org_identifier": int,
    "candidate_name": string,
    "end_time": timestamp,
    "duration": int (milliseconds),
    "metadata" : {
        "reference_id": string,
        "job_id": string,
        "transaction_id": string
   }
}
info

end_time and duration are only sent for "Call completed" status.

call.propertyChange.notes​

Triggered when the notes associated with a call change.

Sample Payload​

{
    "event": "call.propertyChange.notes",
    "call_id": string,
    "start_time": timestamp,
    "call_creator":string,
    "candidate_number": string,
    "virtual_number": string,
    "call_type" : string,
    "org_identifier": int,
    "candidate_name": string,
    "metadata" : {
        "reference_id": string,
        "job_id": string,
        "transaction_id": string
    },
    "call-details": {
        "notes" : string
    }
}

call.propertyChange.call_reason​

Triggered when the call reason associated with a call changes. Payload will be similar to call.propertyChange.notes

call.propertyChange.call_outcome​

Triggered when the call outcome associated with a call changes. Payload will be similar to call.propertyChange.notes

call.recording​

Triggered when the call recording is ready to be fetched/played.

Sample Payload​

{
    "event": "call.recording",
    "call_id": string,
    "start_time": timestamp,
    "call_creator": string,
    "candidate_number": string,
    "virtual_number": string,
    "recording_url": string,
    "call_type" : string,
    "org_identifier": int,
    "candidate_name": string,
    "metadata" : {
        "reference_id": string,
        "job_id": string,
        "transaction_id": string
    }
}