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

Table of contents

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

webhookName

• Optional webhookName: string

Name of the webhook being triggered

memberof WebhookEmailOpenedPayload