Interface: 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.
export
interface WebhookEmailReadPayload
Table of contents
Properties
Properties
createdAt
• createdAt: Date
Date time of event creation
memberof WebhookEmailReadPayload
emailId
• emailId: string
ID of the email that was received. Use this ID for fetching the email with the EmailController.
memberof WebhookEmailReadPayload
emailIsRead
• emailIsRead: boolean
Is the email read
memberof WebhookEmailReadPayload
eventName
• eventName: WebhookEmailReadPayloadEventNameEnum
Name of the event type webhook is being triggered for.
memberof WebhookEmailReadPayload
inboxId
• inboxId: string
Id of the inbox that received an email
memberof WebhookEmailReadPayload
messageId
• messageId: string
Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
memberof WebhookEmailReadPayload
webhookId
• webhookId: string
ID of webhook entity being triggered
memberof WebhookEmailReadPayload
webhookName
• Optional webhookName: string
Name of the webhook being triggered
memberof WebhookEmailReadPayload