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

Hierarchy

  • WebhookEmailReadPayload

Properties

createdAt emailId emailIsRead eventName inboxId messageId webhookId webhookName?

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

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

Optional webhookName

webhookName?: string

Name of the webhook being triggered

Memberof

WebhookEmailReadPayload

Settings

Member Visibility

Theme