Skip to navigation

Message event

Chat Bridge notifies each event of a sent email through an HTTP POST request (webhook). Every event is notified, including repeated opens or clicks of the same message.

The normal flow is SENT → DELIVERED, followed by OPENED and CLICKED when the recipient interacts with it. BOUNCED, SUPPRESSED and FAILED are failures: the email did not reach the recipient. SPAM (complaint) and UNSUBSCRIBED are reported by the recipient’s mailbox provider. DELAYED means the delivery is being retried. device_type, ip and user_agent are only present on OPENED, CLICKED and SPAM events; device_type is PROXY when the mailbox provider opened the email on behalf of the recipient. Your endpoint must accept application/json and respond with a 2xx HTTP code; the response body is ignored.

Payload

The payload of this webhook request is an object.
channelenumOptional
Allowed values:
identifierstringOptional

The message_id returned when sending.

email_addressstringOptional
eventenumOptional
Event that just happened.
statusstring or nullOptional
Current status of the message after the event.
occurred_atdatetimeOptional
detailstring or nullOptional

Clicked link (CLICKED), bounce type (BOUNCED) or complaint type (SPAM).

device_typeenumOptional
Allowed values:
ipstring or nullOptional
user_agentstring or nullOptional

Response

200
Event received and processed by the client.