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
MessageIdstringIdempotent message ID. Store this ID locally or in a database to prevent message duplication.
WebhookIdGuidID of webhook entity being triggered
EventNamestringName of the event type webhook is being triggered for.
WebhookNamestringName of the webhook being triggered[optional]
EmailIdGuidID of the email that was received. Use this ID for fetching the email with the EmailController.
InboxIdGuidId of the inbox that received an email
EmailIsReadboolIs the email read
CreatedAtDateTimeDate time of event creation

[Back to Model list] [Back to API list] [Back to ]