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
5. Call busy

Sample Payload

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

Note

end_time and duration are only sent for “Call completed” status. answer_time is only sent for “Call answered” and “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 (user email),
    "candidate_number": string,
    "virtual_number": string,
    "call_type": string (outbound or inbound),
    "org_identifier": string,
    "candidate_name": string,
    "metadata" : {
        "reference_id": string,
        "job_id": string,
        "transaction_id": string,
        "tags": [
            {
                "id": integer,
                "name": 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.propertyChange.metadata

Triggered when the call metadata (if either of metadata fields like candidate_id, job_id or transaction_id or tags) associated with a call changes. Payload will be similar to call.propertyChange.notes excluding the call-details section as metadata is already included.

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 (user email),
    "candidate_number": string,
    "virtual_number": string,
    "recording_url": string,
    "summary_url": string,
    "call_type": string (outbound or inbound),
    "org_identifier": string,
    "candidate_name": string,
    "metadata" : {
        "reference_id": string,
        "job_id": string,
        "transaction_id": string
    }
}

call.insights

Triggered when call insights are available.

Sample Payload

{
    "event": "call.insights",
    "call_id": string,
    "start_time": timestamp,
    "call_creator": string (user email),
    "creator_number": string,
    "candidate_number": string,
    "candidate_name": string,
    "virtual_number": string,
    "call_type": string (outbound or inbound),
    "transcript": [
        {
            "start": int,
            "end": int,
            "text": string,
            "speaker": string
        }
    ],
    "ai_insights": {
        "talk_ratio": {
            "speaker A": int,
            "speaker B": int
        },
        "sentiment_score": {
            "sentiment": string,
            "percentage": int,
            "sentiment_summary": string
        },
        "summary": {
            "transcript_summary": string,
            "action_items": string
        },
        "questions_covered": {
            "number": int,
            "percentage": string
        },
        "qa": [
            {
                "question": string,
                "answer": string
            }
        ]
    },
    "org_identifier": string,
    "metadata": {
        "reference_id": string,
        "job_id": string,
        "transaction_id": string
    }
}

call.summary

Returns all the data associated to a call, including call status, duration, recording url, notes, insights etc.

Sample Payload

{
    "event": "call.summary",
    "call_id": string,
    "start_time": timestamp,
    "call_creator": string (user email),
    "end_time": timestamp,
    "duration": int (milliseconds),
    "answer_time": timestamp,
    "creator_number": string,
    "candidate_number": string,
    "candidate_name": string,
    "virtual_number": string,
    "call_tags": string,
    "call_reason": string,
    "call_outcome": string,
    "call_notes": string,
    "call_type": string (outbound or inbound),
    "call_status": string,
    "org_identifier": string,
    "recording_url": string,
    "summary_url": string,
    "transcript": [
        {
            "start": int,
            "end": int,
            "text": string,
            "speaker": string
        }
    ],
    "ai_insights": {
        "talk_ratio": {
            "speaker A": int,
            "speaker B": int
        },
        "sentiment_score": {
            "sentiment": string,
            "percentage": int,
            "sentiment_summary": string
        },
        "summary": {
            "transcript_summary": string,
            "action_items": string
        },
        "questions_covered": {
            "number": int,
            "percentage": string
        },
        "qa": [
            {
                "question": string,
                "answer": string
            }
        ]
    },
    "metadata": {
        "reference_id": string,
        "job_id": string,
        "transaction_id": string,
    }
}