Call Task Webhooks

{
  "event_type": "call_task.attempted",
  "data": {
    "call_task": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ext_id": "<string>",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requested_at": "2023-11-07T05:31:56Z",
      "scheduled_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "cancel_requested_at": "2023-11-07T05:31:56Z",
      "attempts": [
        {
          "attempt_number": 123,
          "started_at": "2023-11-07T05:31:56Z",
          "error": {
            "message": "<string>"
          }
        }
      ]
    },
    "attempt": {
      "attempt_number": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "error": {
        "message": "<string>"
      }
    }
  }
}

Webhook payload sent once for each attempt at reaching a call task's contact, saying how the attempt ended and, in the task's status, whether another one follows. Attempts where no call could be placed at all are included.

The call task is sent in the same shape the call task endpoints return.

Every call_task event is published to a channel for the voice agent placing the call (voice_agent_<voice agent ID>). In Settings > Webhooks you can subscribe an endpoint to specific channels so that it only receives the calls you care about. Endpoints without channels receive all events.

event_type

enum<string>

required

The type of webhook event: call_task.attempted when an attempt at reaching the contact has finished.

Available options:

call_task.attempted

data

object

required

Show child attributes

API Documentation

Call monitoring

Outbound calling

Contacts

Teammates

Hiring

Call Task Webhooks