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

Hierarchy

  • WebhookNewAttachmentPayload

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

Optional webhookName

webhookName?: string

Name of the webhook being triggered

Memberof

WebhookNewAttachmentPayload

Settings

Member Visibility

Theme