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

Hierarchy

  • WebhookNewEmailPayload

Properties

attachmentMetaDatas: AttachmentMetaData[]

List of attachment meta data objects if attachments present

Memberof

WebhookNewEmailPayload

bcc: string[]

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

Memberof

WebhookNewEmailPayload

cc: string[]

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

Memberof

WebhookNewEmailPayload

createdAt: Date

Date time of event creation

Memberof

WebhookNewEmailPayload

domainId?: string

Id of the domain that received an email

Memberof

WebhookNewEmailPayload

emailId: string

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

Memberof

WebhookNewEmailPayload

Name of the event type webhook is being triggered for.

Memberof

WebhookNewEmailPayload

from: string

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

Memberof

WebhookNewEmailPayload

inboxId: string

Id of the inbox

Memberof

WebhookNewEmailPayload

messageId: string

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

Memberof

WebhookNewEmailPayload

subject?: string

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

Memberof

WebhookNewEmailPayload

to: string[]

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

Memberof

WebhookNewEmailPayload

webhookId: string

ID of webhook entity being triggered

Memberof

WebhookNewEmailPayload

webhookName?: string

Name of the webhook being triggered

Memberof

WebhookNewEmailPayload