Skip to content

WebhookPayloadMessageDeliveryStatus.md

Latest commit

 

History

History
31 lines (19 loc) · 1.3 KB

WebhookPayloadMessageDeliveryStatus.md

File metadata and controls

31 lines (19 loc) · 1.3 KB

WebhookPayloadMessageDeliveryStatus

Shared payload for message.delivered, message.read, and message.failed events. Fires when the platform reports a new delivery state for an outgoing message. Platform support: * message.delivered — WhatsApp, Facebook Messenger. * message.read — WhatsApp, Facebook Messenger, Instagram. * message.failed — WhatsApp only (other platforms don't expose per-message failure via webhook).

Properties

Name Type Description Notes
id String
event EventEnum
message InboxWebhookMessage
statusAt OffsetDateTime When the platform reported this status.
error WebhookPayloadMessageDeliveryStatusError [optional]
conversation InboxWebhookConversation
account InboxWebhookAccount
timestamp OffsetDateTime

Enum: EventEnum

Name Value
MESSAGE_DELIVERED "message.delivered"
MESSAGE_READ "message.read"
MESSAGE_FAILED "message.failed"