Skip to content

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.

Properties

Name Type Description Notes
messageId String Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
webhookId UUID ID of webhook entity being triggered
eventName EventNameEnum Name of the event type webhook is being triggered for.
webhookName String Name of the webhook being triggered [optional]
id UUID ID of delivery status
userId UUID User ID of event
sentId UUID ID of sent email [optional]
remoteMtaIp String IP address of the remote Mail Transfer Agent [optional]
inboxId UUID Id of the inbox [optional]
reportingMta String Mail Transfer Agent reporting delivery status [optional]
recipients List Recipients for delivery [optional]
smtpResponse String SMTP server response message [optional]
smtpStatusCode Integer SMTP server status [optional]
processingTimeMillis Long Time in milliseconds for delivery processing [optional]
received OffsetDateTime Time event was received [optional]
subject String Email subject [optional]

Enum: EventNameEnum

Name Value
EMAIL_RECEIVED "EMAIL_RECEIVED"
NEW_EMAIL "NEW_EMAIL"
NEW_CONTACT "NEW_CONTACT"
NEW_ATTACHMENT "NEW_ATTACHMENT"
EMAIL_OPENED "EMAIL_OPENED"
EMAIL_READ "EMAIL_READ"
DELIVERY_STATUS "DELIVERY_STATUS"
BOUNCE "BOUNCE"
BOUNCE_RECIPIENT "BOUNCE_RECIPIENT"
NEW_SMS "NEW_SMS"