Webhooks

Message Events

Receive inbound messages and message status updates via webhook. For more information about handling incoming events with our native SDKs, see Receiving Messages.

Payload

The payload of this webhook request is an object.
typeenumRequired
Type of webhook event. MESSAGE.STATUS for message status updates or MESSAGE.RECEIVED for inbound messages.
Allowed values:
conversationobjectRequired
Conversation metadata containing the conversation ID, sender, and recipient information.
statusenumRequired
Current status of the message.
directionenumRequired
Direction of the message flow.
Allowed values:
segmentsintegerRequired
Number of segments for this message.
sentAtstringRequired
Timestamp when the message was sent in ISO 8601 format.
messageobjectRequired
Message details including ID and content.
deliveredAtstring or nullOptional
Timestamp when the message was delivered in ISO 8601 format. Null if not yet delivered or for inbound messages.

Response

200
any
Return a 200 status to indicate that the data was received successfully.