Message status

The message.status notification reports the message delivery result: sent or failed. Sending Messages is the API method that sends the message. When the status is failed, the notification also contains data.error_code and data.error_description.

message.status — sent

Sent when a message is successfully delivered to the recipient. data.state = sent.

json

{
  "event": "message.status",
  "event_version": 1,
  "event_id": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2025-01-15T10:30:05Z",
  "data": {
    "state": "sent"
  }
}

message.status — failed

Sent on delivery failure. data.state = failed + error_code and error_description.

json

{
  "event": "message.status",
  "event_version": 1,
  "event_id": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2025-01-15T10:30:05Z",
  "data": {
    "state": "failed",
    "error_code": "NETWORK_ERROR",
    "error_description": "Network error"
  }
}