Skip to content

WebhookEmailOpenedPayload

EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when an email containing a tracking pixel is opened and the pixel image is loaded by a reader.

Properties

Name Type Description Notes
messageId String Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
webhookId UUID ID of webhook entity being triggered
eventName EventNameEnum Name of the event type webhook is being triggered for.
webhookName String Name of the webhook being triggered [optional]
inboxId UUID Id of the inbox that received an email
pixelId UUID ID of the tracking pixel
sentEmailId UUID ID of sent email
recipient String Email address for the recipient of the tracking pixel
createdAt OffsetDateTime Date time of event creation

Enum: EventNameEnum

Name Value
EMAIL_RECEIVED "EMAIL_RECEIVED"
NEW_EMAIL "NEW_EMAIL"
NEW_CONTACT "NEW_CONTACT"
NEW_ATTACHMENT "NEW_ATTACHMENT"
EMAIL_OPENED "EMAIL_OPENED"
EMAIL_READ "EMAIL_READ"
BOUNCE "BOUNCE"
BOUNCE_RECIPIENT "BOUNCE_RECIPIENT"