Webhooks
ModelsExpand Collapse
class MessageEventV2: …Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead of is_from_me booleansender_handle: Full handle object for the senderchat: Nested object with id, is_group, and owner_handle- Message fields (
id, parts, effect, etc.) are at the top level, not nested in message
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead ofis_from_mebooleansender_handle: Full handle object for the senderchat: Nested object withid,is_group, andowner_handle- Message fields (
id,parts,effect, etc.) are at the top level, not nested inmessage
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
chat: ChatChat information
Chat information
health_status: ChatHealthStatus[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
status: Literal["HEALTHY", "AT_RISK", "CRITICAL", "OPTED_OUT"]Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
direction: Literal["inbound", "outbound"]Message direction - “outbound” if sent by you, “inbound” if received
Message direction - “outbound” if sent by you, “inbound” if received
parts: List[Part]Message parts (text and/or media)
Message parts (text and/or media)
class SchemasTextPartResponse: …A text message part
A text message part
Text decorations applied to character ranges in the value
Text decorations applied to character ranges in the value
Character range [start, end) in the value string where the decoration applies.
start is inclusive, end is exclusive.
Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.
When the message was delivered. Null if not yet delivered.
effect: Optional[SchemasMessageEffect]iMessage effect applied to a message (screen or bubble animation)
iMessage effect applied to a message (screen or bubble animation)
preferred_service: Optional[Literal["iMessage", "SMS", "RCS", "auto"]]Preferred messaging service type. Includes “auto” for default fallback behavior.
Preferred messaging service type. Includes “auto” for default fallback behavior.
class MessagePayload: …Message content nested within webhook events
Message content nested within webhook events
effect: Optional[SchemasMessageEffect]iMessage effect applied to a message (screen or bubble animation)
iMessage effect applied to a message (screen or bubble animation)
parts: Optional[List[Part]]Message content parts (text and/or media)
Message content parts (text and/or media)
class SchemasTextPartResponse: …A text message part
A text message part
Text decorations applied to character ranges in the value
Text decorations applied to character ranges in the value
Character range [start, end) in the value string where the decoration applies.
start is inclusive, end is exclusive.
Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.
class ReactionEventBase: …
Whether this reaction was from the owner of the phone number (true) or from someone else (false)
Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
Custom emoji reactions have type “custom” with the actual emoji in the custom_emoji field.
Sticker reactions have type “sticker” with sticker attachment details in the sticker field.
Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type “custom” with the actual emoji in the custom_emoji field. Sticker reactions have type “sticker” with sticker attachment details in the sticker field.
The actual emoji when reaction_type is “custom”. Null for standard tapbacks.
DEPRECATED: Use from_handle instead. Phone number or email address of the person who added/removed the reaction.
from_handle: Optional[ChatHandle]The person who added/removed the reaction as a full handle object
The person who added/removed the reaction as a full handle object
class SchemasTextPartResponse: …A text message part
A text message part
Text decorations applied to character ranges in the value
Text decorations applied to character ranges in the value
Character range [start, end) in the value string where the decoration applies.
start is inclusive, end is exclusive.
Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.
class MessageSentWebhookEvent: …Complete webhook payload for message.sent events (2026-02-03 format)
Complete webhook payload for message.sent events (2026-02-03 format)
Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead of is_from_me booleansender_handle: Full handle object for the senderchat: Nested object with id, is_group, and owner_handle- Message fields (
id, parts, effect, etc.) are at the top level, not nested in message
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead ofis_from_mebooleansender_handle: Full handle object for the senderchat: Nested object withid,is_group, andowner_handle- Message fields (
id,parts,effect, etc.) are at the top level, not nested inmessage
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
chat: ChatChat information
Chat information
health_status: ChatHealthStatus[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
status: Literal["HEALTHY", "AT_RISK", "CRITICAL", "OPTED_OUT"]Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
direction: Literal["inbound", "outbound"]Message direction - “outbound” if sent by you, “inbound” if received
Message direction - “outbound” if sent by you, “inbound” if received
parts: List[Part]Message parts (text and/or media)
Message parts (text and/or media)
class SchemasTextPartResponse: …A text message part
A text message part
Text decorations applied to character ranges in the value
Text decorations applied to character ranges in the value
Character range [start, end) in the value string where the decoration applies.
start is inclusive, end is exclusive.
Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.
When the message was delivered. Null if not yet delivered.
effect: Optional[SchemasMessageEffect]iMessage effect applied to a message (screen or bubble animation)
iMessage effect applied to a message (screen or bubble animation)
preferred_service: Optional[Literal["iMessage", "SMS", "RCS", "auto"]]Preferred messaging service type. Includes “auto” for default fallback behavior.
Preferred messaging service type. Includes “auto” for default fallback behavior.
class MessageReceivedWebhookEvent: …Complete webhook payload for message.received events (2026-02-03 format)
Complete webhook payload for message.received events (2026-02-03 format)
Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead of is_from_me booleansender_handle: Full handle object for the senderchat: Nested object with id, is_group, and owner_handle- Message fields (
id, parts, effect, etc.) are at the top level, not nested in message
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead ofis_from_mebooleansender_handle: Full handle object for the senderchat: Nested object withid,is_group, andowner_handle- Message fields (
id,parts,effect, etc.) are at the top level, not nested inmessage
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
chat: ChatChat information
Chat information
health_status: ChatHealthStatus[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
status: Literal["HEALTHY", "AT_RISK", "CRITICAL", "OPTED_OUT"]Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
direction: Literal["inbound", "outbound"]Message direction - “outbound” if sent by you, “inbound” if received
Message direction - “outbound” if sent by you, “inbound” if received
parts: List[Part]Message parts (text and/or media)
Message parts (text and/or media)
class SchemasTextPartResponse: …A text message part
A text message part
Text decorations applied to character ranges in the value
Text decorations applied to character ranges in the value
Character range [start, end) in the value string where the decoration applies.
start is inclusive, end is exclusive.
Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.
When the message was delivered. Null if not yet delivered.
effect: Optional[SchemasMessageEffect]iMessage effect applied to a message (screen or bubble animation)
iMessage effect applied to a message (screen or bubble animation)
preferred_service: Optional[Literal["iMessage", "SMS", "RCS", "auto"]]Preferred messaging service type. Includes “auto” for default fallback behavior.
Preferred messaging service type. Includes “auto” for default fallback behavior.
class MessageReadWebhookEvent: …Complete webhook payload for message.read events (2026-02-03 format)
Complete webhook payload for message.read events (2026-02-03 format)
Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead of is_from_me booleansender_handle: Full handle object for the senderchat: Nested object with id, is_group, and owner_handle- Message fields (
id, parts, effect, etc.) are at the top level, not nested in message
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead ofis_from_mebooleansender_handle: Full handle object for the senderchat: Nested object withid,is_group, andowner_handle- Message fields (
id,parts,effect, etc.) are at the top level, not nested inmessage
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
chat: ChatChat information
Chat information
health_status: ChatHealthStatus[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
status: Literal["HEALTHY", "AT_RISK", "CRITICAL", "OPTED_OUT"]Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
direction: Literal["inbound", "outbound"]Message direction - “outbound” if sent by you, “inbound” if received
Message direction - “outbound” if sent by you, “inbound” if received
parts: List[Part]Message parts (text and/or media)
Message parts (text and/or media)
class SchemasTextPartResponse: …A text message part
A text message part
Text decorations applied to character ranges in the value
Text decorations applied to character ranges in the value
Character range [start, end) in the value string where the decoration applies.
start is inclusive, end is exclusive.
Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.
When the message was delivered. Null if not yet delivered.
effect: Optional[SchemasMessageEffect]iMessage effect applied to a message (screen or bubble animation)
iMessage effect applied to a message (screen or bubble animation)
preferred_service: Optional[Literal["iMessage", "SMS", "RCS", "auto"]]Preferred messaging service type. Includes “auto” for default fallback behavior.
Preferred messaging service type. Includes “auto” for default fallback behavior.
class MessageDeliveredWebhookEvent: …Complete webhook payload for message.delivered events (2026-02-03 format)
Complete webhook payload for message.delivered events (2026-02-03 format)
Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead of is_from_me booleansender_handle: Full handle object for the senderchat: Nested object with id, is_group, and owner_handle- Message fields (
id, parts, effect, etc.) are at the top level, not nested in message
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
Unified payload for message webhooks when using webhook_version: "2026-02-03".
This schema is used for message.sent, message.received, message.delivered, and message.read
events when the subscription URL includes ?version=2026-02-03.
Key differences from V1 (2025-01-01):
direction: “inbound” or “outbound” instead ofis_from_mebooleansender_handle: Full handle object for the senderchat: Nested object withid,is_group, andowner_handle- Message fields (
id,parts,effect, etc.) are at the top level, not nested inmessage
Timestamps indicate the message state:
message.sent: sent_at set, delivered_at=null, read_at=nullmessage.received: sent_at set, delivered_at=null, read_at=nullmessage.delivered: sent_at set, delivered_at set, read_at=nullmessage.read: sent_at set, delivered_at set, read_at set
chat: ChatChat information
Chat information
health_status: ChatHealthStatus[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
status: Literal["HEALTHY", "AT_RISK", "CRITICAL", "OPTED_OUT"]Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
direction: Literal["inbound", "outbound"]Message direction - “outbound” if sent by you, “inbound” if received
Message direction - “outbound” if sent by you, “inbound” if received
parts: List[Part]Message parts (text and/or media)
Message parts (text and/or media)
class SchemasTextPartResponse: …A text message part
A text message part
Text decorations applied to character ranges in the value
Text decorations applied to character ranges in the value
Character range [start, end) in the value string where the decoration applies.
start is inclusive, end is exclusive.
Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.
When the message was delivered. Null if not yet delivered.
effect: Optional[SchemasMessageEffect]iMessage effect applied to a message (screen or bubble animation)
iMessage effect applied to a message (screen or bubble animation)
preferred_service: Optional[Literal["iMessage", "SMS", "RCS", "auto"]]Preferred messaging service type. Includes “auto” for default fallback behavior.
Preferred messaging service type. Includes “auto” for default fallback behavior.
class MessageFailedWebhookEvent: …Complete webhook payload for message.failed events
Complete webhook payload for message.failed events
data: DataError details for message.failed webhook events.
See WebhookErrorCode for the full error code reference.
Error details for message.failed webhook events. See WebhookErrorCode for the full error code reference.
class MessageEditedWebhookEvent: …Complete webhook payload for message.edited events (2026-02-03 format only)
Complete webhook payload for message.edited events (2026-02-03 format only)
data: DataPayload for message.edited events (2026-02-03 format).
Describes which part of a message was edited and when. Only text parts can be edited.
Only available for subscriptions using webhook_version: "2026-02-03".
Payload for message.edited events (2026-02-03 format).
Describes which part of a message was edited and when. Only text parts can be edited.
Only available for subscriptions using webhook_version: "2026-02-03".
chat: DataChatChat context
Chat context
health_status: DataChatHealthStatus[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
status: Literal["HEALTHY", "AT_RISK", "CRITICAL", "OPTED_OUT"]Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
direction: Literal["outbound", "inbound"]“outbound” if you sent the original message, “inbound” if you received it
“outbound” if you sent the original message, “inbound” if you received it
class ReactionAddedWebhookEvent: …Complete webhook payload for reaction.added events
Complete webhook payload for reaction.added events
Payload for reaction.added webhook events
Payload for reaction.added webhook events
Whether this reaction was from the owner of the phone number (true) or from someone else (false)
Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
Custom emoji reactions have type “custom” with the actual emoji in the custom_emoji field.
Sticker reactions have type “sticker” with sticker attachment details in the sticker field.
Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type “custom” with the actual emoji in the custom_emoji field. Sticker reactions have type “sticker” with sticker attachment details in the sticker field.
The actual emoji when reaction_type is “custom”. Null for standard tapbacks.
DEPRECATED: Use from_handle instead. Phone number or email address of the person who added/removed the reaction.
from_handle: Optional[ChatHandle]The person who added/removed the reaction as a full handle object
The person who added/removed the reaction as a full handle object
class ReactionRemovedWebhookEvent: …Complete webhook payload for reaction.removed events
Complete webhook payload for reaction.removed events
Payload for reaction.removed webhook events
Payload for reaction.removed webhook events
Whether this reaction was from the owner of the phone number (true) or from someone else (false)
Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
Custom emoji reactions have type “custom” with the actual emoji in the custom_emoji field.
Sticker reactions have type “sticker” with sticker attachment details in the sticker field.
Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type “custom” with the actual emoji in the custom_emoji field. Sticker reactions have type “sticker” with sticker attachment details in the sticker field.
The actual emoji when reaction_type is “custom”. Null for standard tapbacks.
DEPRECATED: Use from_handle instead. Phone number or email address of the person who added/removed the reaction.
from_handle: Optional[ChatHandle]The person who added/removed the reaction as a full handle object
The person who added/removed the reaction as a full handle object
class ParticipantAddedWebhookEvent: …Complete webhook payload for participant.added events
Complete webhook payload for participant.added events
data: DataPayload for participant.added webhook events
Payload for participant.added webhook events
class ParticipantRemovedWebhookEvent: …Complete webhook payload for participant.removed events
Complete webhook payload for participant.removed events
data: DataPayload for participant.removed webhook events
Payload for participant.removed webhook events
class ChatCreatedWebhookEvent: …Complete webhook payload for chat.created events
Complete webhook payload for chat.created events
data: DataPayload for chat.created webhook events. Matches GET /v3/chats/{chatId} response.
Payload for chat.created webhook events. Matches GET /v3/chats/{chatId} response.
Display name for the chat. Defaults to a comma-separated list of recipient handles. Can be updated for group chats.
List of chat participants with full handle details. Always contains at least two handles (your phone number and the other participant).
List of chat participants with full handle details. Always contains at least two handles (your phone number and the other participant).
health_status: DataHealthStatus[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
[BETA] Current health for a chat. Always present — chats start at HEALTHY and may shift based on engagement and delivery signals on the conversation. Many AT_RISK or CRITICAL chats on a single line increase the risk of line flagging.
Switch on status to gate sends or surface line health in your UI — the enum is the long-term contract. Each status carries a doc_url that deep-links to the relevant section of the Chat Health guide.
See the Chat Health guide for what each status means and how to react.
status: Literal["HEALTHY", "AT_RISK", "CRITICAL", "OPTED_OUT"]Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
Current health bucket for the chat. See the Chat Health guide for what each value means and how to react. doc_url deep-links to the relevant section.
class ChatGroupNameUpdatedWebhookEvent: …Complete webhook payload for chat.group_name_updated events
Complete webhook payload for chat.group_name_updated events
data: DataPayload for chat.group_name_updated webhook events
Payload for chat.group_name_updated webhook events
class ChatGroupIconUpdatedWebhookEvent: …Complete webhook payload for chat.group_icon_updated events
Complete webhook payload for chat.group_icon_updated events
data: DataPayload for chat.group_icon_updated webhook events
Payload for chat.group_icon_updated webhook events
class ChatGroupNameUpdateFailedWebhookEvent: …Complete webhook payload for chat.group_name_update_failed events
Complete webhook payload for chat.group_name_update_failed events
data: DataError details for chat.group_name_update_failed webhook events.
See WebhookErrorCode for the full error code reference.
Error details for chat.group_name_update_failed webhook events. See WebhookErrorCode for the full error code reference.
class ChatGroupIconUpdateFailedWebhookEvent: …Complete webhook payload for chat.group_icon_update_failed events
Complete webhook payload for chat.group_icon_update_failed events
data: DataError details for chat.group_icon_update_failed webhook events.
See WebhookErrorCode for the full error code reference.
Error details for chat.group_icon_update_failed webhook events. See WebhookErrorCode for the full error code reference.
class ChatTypingIndicatorStartedWebhookEvent: …Complete webhook payload for chat.typing_indicator.started events
Complete webhook payload for chat.typing_indicator.started events
class ChatTypingIndicatorStoppedWebhookEvent: …Complete webhook payload for chat.typing_indicator.stopped events
Complete webhook payload for chat.typing_indicator.stopped events
class PhoneNumberStatusUpdatedWebhookEvent: …Complete webhook payload for phone_number.status_updated events
Complete webhook payload for phone_number.status_updated events
data: DataPayload for phone_number.status_updated webhook events
Payload for phone_number.status_updated webhook events
Deprecatednew_health_status: Literal["HEALTHY", "AT_RISK", "CRITICAL"]Current reputation of this phone line.
HEALTHY — The line is in good standing. Send normally.AT_RISK — The line’s overall engagement is trending down. Slow the line’s send pace and review your messaging patterns.CRITICAL — Strong signals that messages from this line aren’t landing well. Pause outbound on the line until it recovers.
Defaults to HEALTHY for lines that have not yet been scored.
Current reputation of this phone line.
HEALTHY— The line is in good standing. Send normally.AT_RISK— The line’s overall engagement is trending down. Slow the line’s send pace and review your messaging patterns.CRITICAL— Strong signals that messages from this line aren’t landing well. Pause outbound on the line until it recovers.
Defaults to HEALTHY for lines that have not yet been scored.
Deprecatedprevious_health_status: Literal["HEALTHY", "AT_RISK", "CRITICAL"]Current reputation of this phone line.
HEALTHY — The line is in good standing. Send normally.AT_RISK — The line’s overall engagement is trending down. Slow the line’s send pace and review your messaging patterns.CRITICAL — Strong signals that messages from this line aren’t landing well. Pause outbound on the line until it recovers.
Defaults to HEALTHY for lines that have not yet been scored.
Current reputation of this phone line.
HEALTHY— The line is in good standing. Send normally.AT_RISK— The line’s overall engagement is trending down. Slow the line’s send pace and review your messaging patterns.CRITICAL— Strong signals that messages from this line aren’t landing well. Pause outbound on the line until it recovers.
Defaults to HEALTHY for lines that have not yet been scored.