Skip to content

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.

Properties

Name Type Description Notes
messageId String Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
webhookId UUID ID of webhook entity being triggered
webhookName String Name of the webhook being triggered [optional]
eventName EventNameEnum Name of the event type webhook is being triggered for.
attachmentId String ID of attachment. Use the AttachmentController to
name String Filename of the attachment if present
contentType String Content type of attachment such as 'image/png' or 'application/pdf
contentLength Long Size of attachment in bytes

Enum: EventNameEnum

Name Value
EMAIL_RECEIVED "EMAIL_RECEIVED"
NEW_EMAIL "NEW_EMAIL"
NEW_CONTACT "NEW_CONTACT"
NEW_ATTACHMENT "NEW_ATTACHMENT"
EMAIL_OPENED "EMAIL_OPENED"
EMAIL_READ "EMAIL_READ"
BOUNCE "BOUNCE"
BOUNCE_RECIPIENT "BOUNCE_RECIPIENT"