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

NameTypeDescriptionNotes
attachment_meta_datas**list[AttachmentMetaData]**List of attachment meta data objects if attachments present[optional]
bcclist[str]List of BCC recipients email addresses that the email was addressed to. See recipients object for names.[optional]
cclist[str]List of CC recipients email addresses that the email was addressed to. See recipients object for names.[optional]
created_atdatetimeDate time of event creation[optional]
email_idstrID of the email that was received. Use this ID for fetching the email with the EmailController.[optional]
event_namestrName of the event type webhook is being triggered for.[optional]
_fromstrWho the email was sent from. An email address - see fromName for the sender name.[optional]
inbox_idstrId of the inbox that received an email[optional]
message_idstrIdempotent message ID. Store this ID locally or in a database to prevent message duplication.[optional]
subjectstrThe subject line of the email message as specified by SMTP subject header[optional]
tolist[str]List of To recipient email addresses that the email was addressed to. See recipients object for names.[optional]
webhook_idstrID of webhook entity being triggered[optional]
webhook_namestrName of the webhook being triggered[optional]

[Back to Model list] [Back to API list] [Back to ]