Skip to main content

Overview

Seven triggers, in two families that come from different places. Mailbox events come from a connected mailbox: email.received, email.replied, email.sent and email.bounced. The first three share one payload, and they fire only for mail in a thread that is a conversation in Custral. Whether a thread becomes one is decided by the workspace’s New mail handling setting, or by a mailbox’s own override of it, so mail that setting leaves in the inbox sends nothing. Which of the three a message delivers depends on who sent it. Mail from outside the workspace delivers email.received and email.replied. Mail from one of the workspace’s own connected mailboxes delivers email.sent. Mail the provider files as spam delivers nothing. Engagement events come from mail a workflow or a sequence sent through its Send email step: email.opened, email.clicked and email.unsubscribed. They are driven by the tracking pixel, the tracked links and the unsubscribe link that step adds, so mail typed in the inbox composer produces none of them.
Every incoming message delivers two events. email.received and email.replied fire together, with the same messageId. Subscribe to one of them, or branch on the event field.
No payload carries a message body. Mailbox events carry the addressing, the subject and the ids, and a receiver that needs the content reads the conversation’s messages from the Conversations API.

Email

Connecting a mailbox and working the inbox.

How threading works

How messages group into the threads these payloads name.

Sequences

Automated sends, whose opens and clicks these events report.

Suppressions

What happens to an address after it unsubscribes.

Triggers

email.received

A message from outside the workspace arrived in a connected mailbox, in a thread that is a conversation.

email.replied

Fires alongside email.received for every incoming message, the first one in a thread included.

email.sent

A message from one of the workspace’s connected mailboxes, in a thread that is a conversation.

email.opened

Mail a workflow or sequence sent was opened, as reported by its tracking pixel.

email.clicked

A tracked link in mail a workflow or sequence sent was clicked.

email.bounced

A message sent from a connected mailbox bounced.

email.unsubscribed

A recipient used the unsubscribe link in mail a workflow or sequence sent.