Classet Webhooks Documentation

This page will help you get started with Classet webhooks. You can modify your webhooks in our dashboard once you have been given access to integrate with us.

Triggers

Call Finishes

Currently, we only have one webhook trigger, which is when a call has been completed by a candidate.

Webhook Response Body

Description

When a call is completed, the webhook sends a POST request to your configured endpoint with the following JSON payload.

Response Format

Fields

candidate_id (string): The unique identifier for the candidate.

job_id (string): The unique identifier for the job associated with the call.

job_title (string): The title of the job associated with the call.

call_status (string): The status of the completed call.

transcript (object): An object containing the transcript of the call.

call_details (object): Detailed information about the call, including:

duration (number): The duration of the call in seconds.

start_time (number): The start timestamp of the call in Unix time.

end_time (number): The end timestamp of the call in Unix time.

e2e_latency (number): The end-to-end latency of the call in milliseconds.

call_analysis (object): A detailed analysis of the call, including:

call_summary (string): A summary of the call content.

user_sentiment (string): The sentiment of the user during the call.

agent_sentiment (string): The sentiment of the agent during the call.

call_completion_rating (string): A rating for the call completion.

agent_task_completion_rating (string): A rating for the agent's task completion.

call_completion_rating_reason (string): A reason for the call completion rating.

agent_task_completion_rating_reason (string): A reason for the agent's task completion rating.

org_phone_number (string): The phone number used by the organization for the call.

call_id (string): The unique identifier for the call.

recording_url (string): The URL to access the call recording.

Example 200 Response

{
  "candidate_id": "12345",
  "job_id": "67890",
  "job_title": "CDL Truck Driver",
  "call_status": "call_completed",
  "transcript": [
    {
      "role": "user",
      "words": [
        {
          "end": 0.5,
          "word": "Hello?",
          "start": 0
        }
      ],
      "content": "Hello?"
    }
  ],
  "call_details": {
    "duration": 300,
    "start_time": 1737073800,
    "end_time": 1737074100,
    "e2e_latency": 120,
    "call_analysis": {
      "call_summary": "The AI voice bot called John about the Warehouse Associate position at Example Company in San Francisco, California, providing details about the job and salary. The call was completed successfully.",
      "user_sentiment": "Positive",
      "agent_sentiment": "Positive",
      "call_completion_rating": "Complete",
      "agent_task_completion_rating": "Complete",
      "call_completion_rating_reason": "The call reached a natural conclusion and all necessary information was gathered.",
      "agent_task_completion_rating_reason": "The agent successfully gathered information about John's background and provided him with the necessary job details."
    },
    "org_phone_number": "+1234567890"
  },
  "call_id": "abcdef123456",
  "recording_url": "https://example.com/recordings/abcdef123456.mp3"
}