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
message_id str Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
webhook_id str ID of webhook entity being triggered
event_name str Name of the event type webhook is being triggered for.
webhook_name str Name of the webhook being triggered [optional]
inbox_id str Id of the inbox
domain_id str Id of the domain that received an email [optional]
email_id str ID of the email that was received. Use this ID for fetching the email with the EmailController.
created_at datetime Date time of event creation
to list[str] List of To recipient email addresses that the email was addressed to. See recipients object for names.
_from str Who the email was sent from. An email address - see fromName for the sender name.
cc list[str] List of CC recipients email addresses that the email was addressed to. See recipients object for names.
bcc list[str] List of BCC recipients email addresses that the email was addressed to. See recipients object for names.
subject str The subject line of the email message as specified by SMTP subject header [optional]
attachment_meta_datas list[AttachmentMetaData] List of attachment meta data objects if attachments present

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