Skip to content

Interface: WebhookDeliveryStatusPayload

DELIVERY_STATUS webhook payload. Sent to your webhook url endpoint via HTTP POST when an email delivery status is created. This could be a successful delivery or a delivery failure.

export

interface WebhookDeliveryStatusPayload

Table of contents

Properties

Properties

eventName

eventName: WebhookDeliveryStatusPayloadEventNameEnum

Name of the event type webhook is being triggered for.

memberof WebhookDeliveryStatusPayload


id

id: string

ID of delivery status

memberof WebhookDeliveryStatusPayload


inboxId

Optional inboxId: string

Id of the inbox

memberof WebhookDeliveryStatusPayload


messageId

messageId: string

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

memberof WebhookDeliveryStatusPayload


processingTimeMillis

Optional processingTimeMillis: number

Time in milliseconds for delivery processing

memberof WebhookDeliveryStatusPayload


received

Optional received: Date

Time event was received

memberof WebhookDeliveryStatusPayload


recipients

Optional recipients: string[]

Recipients for delivery

memberof WebhookDeliveryStatusPayload


remoteMtaIp

Optional remoteMtaIp: string

IP address of the remote Mail Transfer Agent

memberof WebhookDeliveryStatusPayload


reportingMta

Optional reportingMta: string

Mail Transfer Agent reporting delivery status

memberof WebhookDeliveryStatusPayload


sentId

Optional sentId: string

ID of sent email

memberof WebhookDeliveryStatusPayload


smtpResponse

Optional smtpResponse: string

SMTP server response message

memberof WebhookDeliveryStatusPayload


smtpStatusCode

Optional smtpStatusCode: number

SMTP server status

memberof WebhookDeliveryStatusPayload


subject

Optional subject: string

Email subject

memberof WebhookDeliveryStatusPayload


userId

userId: string

User ID of event

memberof WebhookDeliveryStatusPayload


webhookId

webhookId: string

ID of webhook entity being triggered

memberof WebhookDeliveryStatusPayload


webhookName

Optional webhookName: string

Name of the webhook being triggered

memberof WebhookDeliveryStatusPayload