Skip to content
MoreVoiceDevelopers

callback.cancelled

POST

A callback was cancelled before it was returned.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
webhook-id
required
string

The event ID (evt_…); the same on every retry. Deduplicate on it.

Example
evt_3fT9kq2ZpLr8YwVbN1cX0a
webhook-timestamp
required
string

Unix seconds of this delivery attempt. Reject deliveries more than 5 minutes old.

Example
1762161262
webhook-signature
required
string

Space-separated v1,<base64 HMAC-SHA256> signatures of <webhook-id>.<webhook-timestamp>.<body> with the endpoint secret (two while a secret rotates).

Example
v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4=

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

A callback was cancelled before it was returned.

object
api_version
required

The API version the payload is rendered in (the endpoint’s pinned version).

string
created
required

An ISO-8601 timestamp in UTC.

string format: date-time
data
required

object is the object the callback.cancelled event is about.

object
object
required
object
agent_id
Any of:
string
>= 1 characters /^usr_[0-9A-Za-z]+$/
assistant_id
Any of:
string
>= 1 characters /^asst_[0-9A-Za-z]+$/
attempts
integer
<= 9007199254740991
call_id
Any of:
string
>= 1 characters /^call_[0-9A-Za-z]+$/
completed_at
string | null
context
object
web
Any of:
object
language
string | null
page

The page the visitor submitted the form on.

string | null
key
additional properties
key
additional properties
created
string
due_at
string | null
id
string
>= 1 characters /^cb_[0-9A-Za-z]+$/
last_result
string | null
max_attempts
integer
> 0 <= 9007199254740991
merged_requests
integer
<= 9007199254740991
metadata
object
key
additional properties
string
name
string
object
string
Allowed value: callback
origin_call_id
Any of:
string
>= 1 characters /^call_[0-9A-Za-z]+$/
phone
string
priority
integer
>= -9007199254740991 <= 9007199254740991
queue_id
Any of:
string
>= 1 characters /^q_[0-9A-Za-z]+$/
reason
string | null
route
string
site_id

The web-form site the request came from (source = web).

string | null
source
string
status
string
updated
string
window_end
string | null
key
additional properties
previous_attributes

For *.updated-style events: the changed attributes’ previous values.

object
key
additional properties
id
required

The event ID. Receivers deduplicate on it (it is also the webhook-id header).

string
/^evt_[0-9A-Za-z]+$/
livemode
required

true in live mode, false in test mode.

boolean
object
required
string
Allowed value: event
org_id
required

The organisation the event belongs to.

string
/^org_[0-9A-Za-z]+$/
request
object
id
required
Any of:

The API request that caused the event (its X-Request-Id), if any.

string
/^req_[0-9A-Za-z]+$/
idempotency_key
required

That request’s Idempotency-Key, if any.

string | null
type
required
string
Allowed value: callback.cancelled
Example
{
  "api_version": "2026-11-01",
  "created": "2026-11-03T09:14:22.000Z",
  "data": {
    "object": {
      "agent_id": "usr_yhfp6RLIuxEKA5Zn4hcCNX",
      "assistant_id": "asst_yosOhvUkeWL0SUSxrLfMTg",
      "attempts": 3,
      "call_id": "call_Oxtl48GXWtJCwMfHzxm0oL",
      "completed_at": "2026-11-03T09:14:22Z",
      "context": {
        "web": {
          "language": "he",
          "page": "…"
        }
      },
      "created": "2026-11-03T09:14:22Z",
      "due_at": "2026-11-03T09:14:22Z",
      "id": "cb_rHpPbEFvGSP3CK9gAuNkH4",
      "last_result": "…",
      "max_attempts": 3,
      "merged_requests": 1,
      "metadata": {},
      "name": "…",
      "object": "callback",
      "origin_call_id": "call_S7vVVKaQp2VnhqHQtXzIwV",
      "phone": "+972501234567",
      "priority": 1,
      "queue_id": "q_FG2uL2gdWXNMUfXZyRFLfT",
      "reason": "…",
      "route": "…",
      "site_id": "…",
      "source": "…",
      "status": "…",
      "updated": "…",
      "window_end": "…"
    }
  },
  "id": "evt_3fT9kq2ZpLr8YwVbN1cX0a",
  "livemode": true,
  "object": "event",
  "org_id": "org_0000000000000000000001",
  "request": {
    "id": null,
    "idempotency_key": null
  },
  "type": "callback.cancelled"
}

Responses

Section titled “Responses”

2XX

Section titled “2XX”

Acknowledge the event with any 2xx status within 15 seconds. Anything else, or a timeout, is retried for up to 72 hours.