Skip to content

WebhookNewEmailPayload

Properties

Name Type Description Notes
messageId kotlin.String Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
webhookId java.util.UUID ID of webhook entity being triggered
eventName inline Name of the event type webhook is being triggered for.
inboxId java.util.UUID Id of the inbox
emailId java.util.UUID ID of the email that was received. Use this ID for fetching the email with the EmailController.
createdAt java.time.OffsetDateTime Date time of event creation
to kotlin.collections.List List of To recipient email addresses that the email was addressed to. See recipients object for names.
from kotlin.String Who the email was sent from. An email address - see fromName for the sender name.
cc kotlin.collections.List List of CC recipients email addresses that the email was addressed to. See recipients object for names.
bcc kotlin.collections.List List of BCC recipients email addresses that the email was addressed to. See recipients object for names.
attachmentMetaDatas kotlin.collections.List List of attachment meta data objects if attachments present
webhookName kotlin.String Name of the webhook being triggered [optional]
domainId java.util.UUID Id of the domain that received an email [optional]
subject kotlin.String The subject line of the email message as specified by SMTP subject header [optional]

Enum: eventName

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