WebhookEmailReadPayload

EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is read. This happens when an email is requested in full from the API or a user views the email in the dashboard.

Properties

NameTypeDescriptionNotes
createdAtOffsetDateTimeDate time of event creation[optional]
emailIdUUIDID of the email that was received. Use this ID for fetching the email with the EmailController.[optional]
emailIsReadBooleanIs the email read[optional]
eventNameEventNameEnumName of the event type webhook is being triggered for.[optional]
inboxIdUUIDId of the inbox that received an email[optional]
messageIdStringIdempotent message ID. Store this ID locally or in a database to prevent message duplication.[optional]
webhookIdUUIDID of webhook entity being triggered[optional]
webhookNameStringName of the webhook being triggered[optional]

Enum: EventNameEnum

NameValue
EMAIL_RECEIVED“EMAIL_RECEIVED”
NEW_EMAIL“NEW_EMAIL”
NEW_CONTACT“NEW_CONTACT”
NEW_ATTACHMENT“NEW_ATTACHMENT”
EMAIL_OPENED“EMAIL_OPENED”
EMAIL_READ“EMAIL_READ”