Interface 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.

Export

Interface

WebhookEmailOpenedPayload

Hierarchy

  • WebhookEmailOpenedPayload

Properties

createdAt eventName inboxId messageId pixelId recipient sentEmailId webhookId webhookName?

Properties

createdAt

createdAt: Date

Date time of event creation

Memberof

WebhookEmailOpenedPayload

eventName

eventName: WebhookEmailOpenedPayloadEventNameEnum

Name of the event type webhook is being triggered for.

Memberof

WebhookEmailOpenedPayload

inboxId

inboxId: string

Id of the inbox

Memberof

WebhookEmailOpenedPayload

messageId

messageId: string

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

Memberof

WebhookEmailOpenedPayload

pixelId

pixelId: string

ID of the tracking pixel

Memberof

WebhookEmailOpenedPayload

recipient

recipient: string

Email address for the recipient of the tracking pixel

Memberof

WebhookEmailOpenedPayload

sentEmailId

sentEmailId: string

ID of sent email

Memberof

WebhookEmailOpenedPayload

webhookId

webhookId: string

ID of webhook entity being triggered

Memberof

WebhookEmailOpenedPayload

Optional webhookName

webhookName?: string

Name of the webhook being triggered

Memberof

WebhookEmailOpenedPayload

Settings

Member Visibility

Theme