WebhookNewEmailPayload

Properties

NameTypeDescriptionNotes
attachmentMetaDataskotlin.collections.ListList of attachment meta data objects if attachments present[optional]
bcckotlin.collections.List<kotlin.String>List of BCC recipients email addresses that the email was addressed to. See recipients object for names.[optional]
cckotlin.collections.List<kotlin.String>List of CC recipients email addresses that the email was addressed to. See recipients object for names.[optional]
createdAtjava.time.OffsetDateTimeDate time of event creation[optional]
emailIdjava.util.UUIDID of the email that was received. Use this ID for fetching the email with the EmailController.[optional]
eventNameinlineName of the event type webhook is being triggered for.[optional]
fromkotlin.StringWho the email was sent from. An email address - see fromName for the sender name.[optional]
inboxIdjava.util.UUIDId of the inbox that received an email[optional]
messageIdkotlin.StringIdempotent message ID. Store this ID locally or in a database to prevent message duplication.[optional]
subjectkotlin.StringThe subject line of the email message as specified by SMTP subject header[optional]
tokotlin.collections.List<kotlin.String>List of To recipient email addresses that the email was addressed to. See recipients object for names.[optional]
webhookIdjava.util.UUIDID of webhook entity being triggered[optional]
webhookNamekotlin.StringName of the webhook being triggered[optional]

Enum: eventName

NameValue
eventNameEMAIL_RECEIVED, NEW_EMAIL, NEW_CONTACT, NEW_ATTACHMENT, EMAIL_OPENED, EMAIL_READ