Interface: WebhookNewAttachmentPayload

NEW_ATTACHMENT 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 that contains an attachment. You can use the attachmentId to download the attachment.

export

interface WebhookNewAttachmentPayload

Table of contents

Properties

• attachmentId
• contentLength
• contentType
• eventName
• messageId
• name
• webhookId
• webhookName

Properties

attachmentId

• attachmentId: string

ID of attachment. Use the AttachmentController to

memberof WebhookNewAttachmentPayload

contentLength

• contentLength: number

Size of attachment in bytes

memberof WebhookNewAttachmentPayload

contentType

• contentType: string

Content type of attachment such as 'image/png' or 'application/pdf

memberof WebhookNewAttachmentPayload

eventName

• eventName: WebhookNewAttachmentPayloadEventNameEnum

Name of the event type webhook is being triggered for.

memberof WebhookNewAttachmentPayload

messageId

• messageId: string

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

memberof WebhookNewAttachmentPayload

name

• name: string

Filename of the attachment if present

memberof WebhookNewAttachmentPayload

webhookId

• webhookId: string

ID of webhook entity being triggered

memberof WebhookNewAttachmentPayload

webhookName

• Optional webhookName: string

Name of the webhook being triggered

memberof WebhookNewAttachmentPayload