Skip to content

WebhookNewEmailPayload

NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to. Use the email ID to fetch the full email body or attachments.

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]
inboxId UUID Id of the inbox
domainId UUID Id of the domain that received an email [optional]
emailId UUID ID of the email that was received. Use this ID for fetching the email with the EmailController.
createdAt OffsetDateTime Date time of event creation
to List List of To recipient email addresses that the email was addressed to. See recipients object for names.
from String Who the email was sent from. An email address - see fromName for the sender name.
cc List List of CC recipients email addresses that the email was addressed to. See recipients object for names.
bcc List List of BCC recipients email addresses that the email was addressed to. See recipients object for names.
subject String The subject line of the email message as specified by SMTP subject header [optional]
attachmentMetaDatas List List of attachment meta data objects if attachments present

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"