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

Hierarchy

  • WebhookDeliveryStatusPayload

Properties

Name of the event type webhook is being triggered for.

Memberof

WebhookDeliveryStatusPayload

id: string

ID of delivery status

Memberof

WebhookDeliveryStatusPayload

inboxId?: string

Id of the inbox

Memberof

WebhookDeliveryStatusPayload

messageId: string

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

Memberof

WebhookDeliveryStatusPayload

processingTimeMillis?: number

Time in milliseconds for delivery processing

Memberof

WebhookDeliveryStatusPayload

received?: Date

Time event was received

Memberof

WebhookDeliveryStatusPayload

recipients?: string[]

Recipients for delivery

Memberof

WebhookDeliveryStatusPayload

remoteMtaIp?: string

IP address of the remote Mail Transfer Agent

Memberof

WebhookDeliveryStatusPayload

reportingMta?: string

Mail Transfer Agent reporting delivery status

Memberof

WebhookDeliveryStatusPayload

sentId?: string

ID of sent email

Memberof

WebhookDeliveryStatusPayload

smtpResponse?: string

SMTP server response message

Memberof

WebhookDeliveryStatusPayload

smtpStatusCode?: number

SMTP server status

Memberof

WebhookDeliveryStatusPayload

subject?: string

Email subject

Memberof

WebhookDeliveryStatusPayload

userId: string

User ID of event

Memberof

WebhookDeliveryStatusPayload

webhookId: string

ID of webhook entity being triggered

Memberof

WebhookDeliveryStatusPayload

webhookName?: string

Name of the webhook being triggered

Memberof

WebhookDeliveryStatusPayload