Skip to content

Interface: 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.

export

interface WebhookNewEmailPayload

Table of contents

Properties

Properties

attachmentMetaDatas

attachmentMetaDatas: AttachmentMetaData[]

List of attachment meta data objects if attachments present

memberof WebhookNewEmailPayload


bcc

bcc: string[]

List of BCC recipients email addresses that the email was addressed to. See recipients object for names.

memberof WebhookNewEmailPayload


cc

cc: string[]

List of CC recipients email addresses that the email was addressed to. See recipients object for names.

memberof WebhookNewEmailPayload


createdAt

createdAt: Date

Date time of event creation

memberof WebhookNewEmailPayload


emailId

emailId: string

ID of the email that was received. Use this ID for fetching the email with the EmailController.

memberof WebhookNewEmailPayload


eventName

eventName: WebhookNewEmailPayloadEventNameEnum

Name of the event type webhook is being triggered for.

memberof WebhookNewEmailPayload


from

from: string

Who the email was sent from. An email address - see fromName for the sender name.

memberof WebhookNewEmailPayload


inboxId

inboxId: string

Id of the inbox that received an email

memberof WebhookNewEmailPayload


messageId

messageId: string

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

memberof WebhookNewEmailPayload


subject

Optional subject: string

The subject line of the email message as specified by SMTP subject header

memberof WebhookNewEmailPayload


to

to: string[]

List of To recipient email addresses that the email was addressed to. See recipients object for names.

memberof WebhookNewEmailPayload


webhookId

webhookId: string

ID of webhook entity being triggered

memberof WebhookNewEmailPayload


webhookName

Optional webhookName: string

Name of the webhook being triggered

memberof WebhookNewEmailPayload