message.accepted
ShipMsg accepted the message and queued it.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "queued" | yes |
Messaging
Event catalogue
The 152 event types a webhook endpoint can receive. Every event shares one envelope (id, type, apiVersion, occurredAt, sequence, livemode, accountSid, data); data holds the resource listed below. This list is generated from the same schemas the platform validates events against.
Subscribe with exact types or wildcards such as message.*. How to receive them: webhooks.
Generated event catalogue descriptions, resource labels, fields and types are shown in their original contract language.
Messages
Every step of an outbound message, and every inbound message.
message.scheduled
The message is waiting for its sendAt time.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "scheduled" | yes |
message.deferred
Sending was postponed on purpose (pacing, a recipient cap or quiet hours); queuedReason and readyAt say why and until when.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | yes |
readyAt | string (date-time) | yes |
status | "queued" | yes |
message.meta_accepted
WhatsApp accepted the request to send the message.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "sending" | yes |
message.held_for_quality
WhatsApp is holding the message while it assesses its quality.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "sending" | yes |
message.sent
WhatsApp sent the message.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "sent" | yes |
message.delivered
The message reached the customer's phone.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "delivered" | yes |
message.read
The customer opened the message.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "read" | yes |
message.played
The customer played the voice message.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "played" | yes |
message.warning
WhatsApp reported a non-fatal problem with the message.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "queued" | "scheduled" | "sending" | "sent" | "delivered" | "read" | "played" | "failed" | "canceled" | "expired" | "unknown" | yes |
message.deleted
The customer deleted the message.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | "inbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "queued" | "scheduled" | "sending" | "sent" | "delivered" | "read" | "played" | "failed" | "canceled" | "expired" | "unknown" | yes |
message.failed
The message will not be delivered; data.error says why.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | yes |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "failed" | yes |
message.expired
The message's validity period ended before it could be sent.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | yes |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "expired" | yes |
message.canceled
The message was canceled before it was sent.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "canceled" | yes |
message.recipient_opted_out
The recipient opted out of this kind of message, so it was not sent.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "failed" | yes |
message.unknown
WhatsApp has not reported what happened to the message.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "unknown" | yes |
message.duplicate_detected
A second send of the same message was detected and not sent again.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
duplicateOfAttempt | integer (1–) | |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "queued" | "scheduled" | "sending" | "sent" | "delivered" | "read" | "played" | "failed" | "canceled" | "expired" | "unknown" | yes |
message.redacted
The message's content was erased (retention or a deletion request).
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | "inbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "queued" | "scheduled" | "sending" | "sent" | "delivered" | "read" | "played" | "failed" | "canceled" | "expired" | "unknown" | yes |
message.received
A customer sent you a message.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "inbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "delivered" | yes |
message.echoed
A message was sent from the WhatsApp Business app on a shared (coexistence) number.
data is a Message resource, with:
| Field | Type | Always present |
|---|---|---|
direction | "outbound" | yes |
error | object | |
queuedReason | string | null | |
readyAt | string (date-time) | null | |
status | "sent" | yes |
message.inbound
An inbound message was added to an inbox conversation.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
message.outbound
An outbound message was added to an inbox conversation.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
message.batch.completed
A batch send finished.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "message_batch" | yes |
sid | string | yes |
Conversations
Inbox conversations: routing, assignment, service windows and surveys.
conversation.opened
conversation opened.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.routed
conversation routed.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | yes |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.assigned
conversation assigned.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | yes |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.released
conversation released.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | yes |
reason | string | yes |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.closed
conversation closed.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | yes |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | yes |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.reopened
conversation reopened.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | yes |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | yes |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.snoozed
conversation snoozed.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | yes |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | yes |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | yes |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.unsnoozed
conversation unsnoozed.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | yes |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | yes |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.collaborator_added
conversation collaborator added.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | yes |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | yes |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | yes |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.collaborator_removed
conversation collaborator removed.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | yes |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | yes |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.bot_handoff_requested
conversation bot handoff requested.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | yes |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | yes |
handoffSid | string (BH… SID) | yes |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) | yes |
conversation.bot_handoff_unavailable
conversation bot handoff unavailable.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | yes |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | yes |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | yes |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.bot_handoff_accepted
conversation bot handoff accepted.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | yes |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | yes |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.bot_handoff_completed
conversation bot handoff completed.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | yes |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | yes |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.bot_handoff_failed
conversation bot handoff failed.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | yes |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | yes |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.bot_handoff_timed_out
conversation bot handoff timed out.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | yes |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | yes |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.bot_handoff_taken_over
conversation bot handoff taken over.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | yes |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | yes |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.note_created
conversation note created.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | yes |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.tag_added
conversation tag added.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | yes |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | yes |
webhookEndpointSid | string (WH… SID) |
conversation.tag_removed
conversation tag removed.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | yes |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | yes |
webhookEndpointSid | string (WH… SID) |
conversation.sla_warning
conversation sla warning.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | yes |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | yes |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.sla_breached
conversation sla breached.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | yes |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | yes |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.window_opened
conversation window opened.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.window_expiring
conversation window expiring.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | yes |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.window_expired
conversation window expired.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | yes |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.csat_dispatched
conversation csat dispatched.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | yes |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
conversation.csat_skipped
conversation csat skipped.
data is a Conversation resource, with:
| Field | Type | Always present |
|---|---|---|
actingPrincipalRef | string | |
applicationSid | string (BA… SID) | |
assigneePrincipalRef | string | |
automatic | boolean | |
clock | "first_response" | "next_response" | "resolution" | |
collaboratorPrincipalRef | string | |
collaboratorRole | "COLLABORATOR" | "FOLLOWER" | |
dueAt | string (date-time) | |
expiresAt | string (date-time) | |
handoffSid | string (BH… SID) | |
humanFallback | boolean | |
noteSid | string (NT… SID) | |
priorAssigneePrincipalRef | string | |
reason | string | yes |
routingRuleId | string | null (uuid) | |
snoozedUntil | string (date-time) | |
state | "open" | "idle" | "closed" | "archived" | |
tag | string | |
webhookEndpointSid | string (WH… SID) |
api key
api_key.created
api key created.
data is a API key resource, with:
| Field | Type | Always present |
|---|---|---|
status | "active" | yes |
api_key.disabled
api key disabled.
data is a API key resource, with:
| Field | Type | Always present |
|---|---|---|
status | "disabled" | yes |
api_key.revoked
api key revoked.
data is a API key resource, with:
| Field | Type | Always present |
|---|---|---|
status | "revoked" | yes |
api_key.rotated
api key rotated.
data is a API key resource, with:
| Field | Type | Always present |
|---|---|---|
status | "active" | yes |
api_key.inactive_flagged
api key inactive flagged.
data is a API key resource, with:
| Field | Type | Always present |
|---|---|---|
status | "active" | yes |
user
user.invited
user invited.
data is a User resource, with:
| Field | Type | Always present |
|---|---|---|
status | "invited" | yes |
user.updated
user updated.
data is a User resource, with:
| Field | Type | Always present |
|---|---|---|
status | "invited" | "active" | "locked" | "disabled" | yes |
user.disabled
user disabled.
data is a User resource, with:
| Field | Type | Always present |
|---|---|---|
status | "disabled" | yes |
account
account.suspended
account suspended.
data is a Account resource, with:
| Field | Type | Always present |
|---|---|---|
status | "suspended" | yes |
account.reinstated
account reinstated.
data is a Account resource, with:
| Field | Type | Always present |
|---|---|---|
status | "active" | yes |
Contacts
Contact records, identifiers, opt-outs and merges.
contact.created
contact created.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "contact" | yes |
sid | string | yes |
contact.updated
contact updated.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "contact" | yes |
sid | string | yes |
contact.identifier_added
contact identifier added.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "contact" | yes |
sid | string | yes |
contact.user_id_updated
contact user id updated.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "contact" | yes |
sid | string | yes |
contact.opted_out
contact opted out.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "contact" | yes |
sid | string | yes |
contact.opted_in
contact opted in.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "contact" | yes |
sid | string | yes |
contact.conflict
contact conflict.
Fields in data (8)
| Field | Type | Always present |
|---|---|---|
conflictId | string (uuid) | yes |
contactId | string (uuid) | yes |
identifierType | "PHONE_E164" | "BSUID" | "USERNAME" | yes |
object | "contact" | yes |
owningContactId | string (uuid) | yes |
scopeRef | string | null | yes |
sid | string | yes |
source | string | yes |
contact.merged
contact merged.
Fields in data (10)
| Field | Type | Always present |
|---|---|---|
contactId | string (uuid) | yes |
mergeId | string (uuid) | yes |
mergedContactId | string (uuid) | yes |
mergedContactSid | string (CT… SID) | yes |
movedIdentifiers | integer (0–) | yes |
object | "contact" | yes |
reason | string | yes |
reversibleForDays | integer (0–) | yes |
sid | string | yes |
survivorContactSid | string (CT… SID) | yes |
contact.unmerged
contact unmerged.
Fields in data (5)
| Field | Type | Always present |
|---|---|---|
contactId | string (uuid) | yes |
mergeId | string (uuid) | yes |
object | "contact" | yes |
sid | string | yes |
survivorContactId | string (uuid) | yes |
Consent
Opt-in and opt-out records.
consent.recorded
consent recorded.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "consent" | yes |
sid | string | yes |
consent.withdrawn
consent withdrawn.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "consent" | yes |
sid | string | yes |
Suppression
Numbers blocked from some or all messages.
suppression.added
suppression added.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "suppression" | yes |
sid | string | yes |
suppression.removed
suppression removed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "suppression" | yes |
sid | string | yes |
Senders
Your WhatsApp numbers: connection, quality, limits and restrictions.
sender.created
sender created.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.connected
sender connected.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.status_changed
sender status changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.health_changed
sender health changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.quality_changed
sender quality changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.throughput_changed
sender throughput changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.limit_changed
sender limit changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.restricted
sender restricted.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.disconnected
sender disconnected.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.reconnected
sender reconnected.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.name_status_changed
sender name status changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.migrated
sender migrated.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
sender.ownership_changed
sender ownership changed.
Fields in data (12)
| Field | Type | Always present |
|---|---|---|
activeRegion | string | yes |
actor | string | |
epochIssuedAt | string (date-time) | yes |
executionEpoch | integer (0–) | yes |
fromAccountSid | string (AC… SID) | |
homeRegion | string | yes |
object | "sender" | yes |
operationSid | string (OP… SID) | |
senderSid | string (WA… SID) | |
sid | string | yes |
toAccountSid | string (AC… SID) | |
wabaId | string |
WhatsApp Business Accounts
Connection and review state of the accounts that own your numbers.
waba.connected
waba connected.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "waba" | yes |
sid | string | yes |
waba.disconnected
waba disconnected.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "waba" | yes |
sid | string | yes |
waba.review_changed
waba review changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "waba" | yes |
sid | string | yes |
waba.billing_mode_changed
waba billing mode changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "waba" | yes |
sid | string | yes |
onboarding
onboarding.abandoned
onboarding abandoned.
Fields in data (5)
| Field | Type | Always present |
|---|---|---|
currentStep | string | yes |
embeddedSignupSessionId | string | null | |
event | "CANCEL" | yes |
object | "onboarding_session" | yes |
sid | string | yes |
Templates
Review decisions, category changes, quality and pauses.
template.submitted
template submitted.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "template" | yes |
sid | string | yes |
template.status_changed
WhatsApp approved, rejected, paused or disabled a template.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "template" | yes |
sid | string | yes |
template.category_changed
template category changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "template" | yes |
sid | string | yes |
template.quality_changed
template quality changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "template" | yes |
sid | string | yes |
template.paused
template paused.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "template" | yes |
sid | string | yes |
template.disabled
template disabled.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "template" | yes |
sid | string | yes |
template.components_updated
template components updated.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "template" | yes |
sid | string | yes |
template.deleted
template deleted.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "template" | yes |
sid | string | yes |
Campaigns
Campaign state and batches.
campaign.state_changed
campaign state changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign" | yes |
sid | string | yes |
campaign.pending_approval
campaign pending approval.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign" | yes |
sid | string | yes |
campaign.started
campaign started.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign" | yes |
sid | string | yes |
campaign.paused
campaign paused.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign" | yes |
sid | string | yes |
campaign.resumed
campaign resumed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign" | yes |
sid | string | yes |
campaign.completed
campaign completed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign" | yes |
sid | string | yes |
campaign.canceled
campaign canceled.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign" | yes |
sid | string | yes |
campaign.failed
campaign failed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign" | yes |
sid | string | yes |
campaign.batch.planned
campaign batch planned.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign_batch" | yes |
sid | string | yes |
campaign.batch.completed
campaign batch completed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "campaign_batch" | yes |
sid | string | yes |
Operations
Long-running jobs such as template submissions, imports and exports.
operation.state_changed
operation state changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "operation" | yes |
sid | string | yes |
operation.completed
operation completed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "operation" | yes |
sid | string | yes |
Media
Uploaded files after scanning, and before they expire.
media.ready
media ready.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "media" | yes |
sid | string | yes |
media.rejected
media rejected.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "media" | yes |
sid | string | yes |
media.expiring
media expiring.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "media" | yes |
sid | string | yes |
flow
flow.status_changed
flow status changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "flow" | yes |
sid | string | yes |
flow.endpoint_unhealthy
flow endpoint unhealthy.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "flow" | yes |
sid | string | yes |
approval
approval.requested
approval requested.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "approval" | yes |
sid | string | yes |
coexistence
coexistence.sync_deadline
coexistence sync deadline.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "coexistence" | yes |
sid | string | yes |
mfa
mfa.changed
mfa changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "mfa" | yes |
sid | string | yes |
security
security.new_device_login
security new device login.
Fields in data (5)
| Field | Type | Always present |
|---|---|---|
authenticationMethod | "password" | "magic_link" | "oidc" | "saml" | yes |
device | string (max 120 chars) | yes |
object | "user" | yes |
sessionId | string (uuid) | yes |
sid | string | yes |
security.account_locked
security account locked.
Fields in data (4)
| Field | Type | Always present |
|---|---|---|
failedLoginCount | integer (1–) | yes |
lockedUntil | string (date-time) | yes |
object | "user" | yes |
sid | string | yes |
security.password_reset
security password reset.
Fields in data (4)
| Field | Type | Always present |
|---|---|---|
mfaRevoked | boolean | yes |
object | "user" | yes |
sessionsRevoked | integer (0–) | yes |
sid | string | yes |
risk
risk.review_required
risk review required.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "risk_decision" | yes |
sid | string | yes |
call
call.permission_replied
call permission replied.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "call" | yes |
sid | string | yes |
call.started
call started.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "call" | yes |
sid | string | yes |
call.ended
call ended.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "call" | yes |
sid | string | yes |
call.failed
call failed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "call" | yes |
sid | string | yes |
Webhook endpoints
Your endpoints’ own health: verification, pauses and suspensions.
webhook.endpoint.verified
webhook endpoint verified.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "webhook_endpoint" | yes |
sid | string | yes |
webhook.endpoint.paused
webhook endpoint paused.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "webhook_endpoint" | yes |
sid | string | yes |
webhook.endpoint.resumed
webhook endpoint resumed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "webhook_endpoint" | yes |
sid | string | yes |
webhook.endpoint.suspended
webhook endpoint suspended.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "webhook_endpoint" | yes |
sid | string | yes |
webhook.endpoint.secret_rotated
webhook endpoint secret rotated.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "webhook_endpoint" | yes |
sid | string | yes |
webhook.endpoint.failing
webhook endpoint failing.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "webhook_endpoint" | yes |
sid | string | yes |
Test
The verification challenge and test events.
test.ping
The endpoint verification challenge or a test event; answer with data.challenge.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "webhook_endpoint" | yes |
sid | string | yes |
credential
credential.invalidated
credential invalidated.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "credential" | yes |
sid | string | yes |
delegated access
delegated_access.granted
delegated access granted.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "delegated_access" | yes |
sid | string | yes |
delegated_access.ended
delegated access ended.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "delegated_access" | yes |
sid | string | yes |
account alerts
account_alerts
account alerts.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "sender" | yes |
sid | string | yes |
payment configuration update
payment_configuration_update
payment configuration update.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "waba" | yes |
sid | string | yes |
wallet
wallet.low_balance
wallet low balance.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "wallet" | yes |
sid | string | yes |
invoice
invoice.created
invoice created.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "invoice" | yes |
sid | string | yes |
invoice.paid
invoice paid.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "invoice" | yes |
sid | string | yes |
invoice.overdue
invoice overdue.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "invoice" | yes |
sid | string | yes |
invoice.opened
invoice opened.
Fields in data (5)
| Field | Type | Always present |
|---|---|---|
artifactSha256 | string (pattern ^[0-9a-f]{64}$) | yes |
invoiceSid | string (IN… SID) | yes |
object | "invoice" | yes |
providerInvoiceRef | string | yes |
sid | string | yes |
billing mode
billing_mode.changed
billing mode changed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "waba" | yes |
sid | string | yes |
deletion
deletion.requested
deletion requested.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "deletion_request" | yes |
sid | string | yes |
deletion.completed
deletion completed.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "deletion_request" | yes |
sid | string | yes |
export
export.ready
export ready.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "export" | yes |
sid | string | yes |
platform
platform.incident
platform incident.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "incident" | yes |
sid | string | yes |
platform.provider_change
platform provider change.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "provider_change" | yes |
sid | string | yes |
platform.api_deprecation
platform api deprecation.
Fields in data (2)
| Field | Type | Always present |
|---|---|---|
object | "provider_change" | yes |
sid | string | yes |
notification
notification.created
notification created.
Fields in data (6)
| Field | Type | Always present |
|---|---|---|
category | string | yes |
object | "notification" | yes |
resourceRef | string | yes |
severity | string | yes |
sid | string | yes |
targetRole | string | yes |
Resources carried in data
Message resource
Fields every event carrying a Message resource includes.
| Field | Type | Always present |
|---|---|---|
attempt | integer (1–) | |
createdAt | string (date-time) | yes |
deliverBefore | string (date-time) | null | |
deliveredAt | string (date-time) | null | |
from | string (WA… SID) | yes |
livemode | boolean | yes |
metadata | object | |
object | "message" | yes |
priority | "critical" | "transactional" | "normal" | "marketing" | |
providerMessageId | string | null | |
readAt | string (date-time) | null | |
sentAt | string (date-time) | null | |
sid | string (SM… SID) | yes |
to | object | yes |
type | string | yes |
updatedAt | string (date-time) |
Conversation resource
Fields every event carrying a Conversation resource includes.
| Field | Type | Always present |
|---|---|---|
attempt | integer (1–) | |
contactSid | string (CT… SID) | |
inboxSid | string (IB… SID) | |
object | "conversation" | yes |
senderSid | string (WA… SID) | |
sid | string (CO… SID) | yes |
version | integer (1–) |
API key resource
Fields every event carrying a API key resource includes.
| Field | Type | Always present |
|---|---|---|
object | "api_key" | yes |
sid | string (SK… SID) | yes |
User resource
Fields every event carrying a User resource includes.
| Field | Type | Always present |
|---|---|---|
object | "user" | yes |
sid | string (US… SID) | yes |
Account resource
Fields every event carrying a Account resource includes.
| Field | Type | Always present |
|---|---|---|
object | "account" | yes |
operationSid | string (OP… SID) | yes |
sid | string (AC… SID) | yes |