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

NameTypeDescriptionNotes
attachmentIdStringID of attachment. Use the AttachmentController to[optional]
contentLengthLongSize of attachment in bytes[optional]
contentTypeStringContent type of attachment such as ‘image/png’ or ‘application/pdf[optional]
eventNameEventNameEnumName of the event type webhook is being triggered for.[optional]
messageIdStringIdempotent message ID. Store this ID locally or in a database to prevent message duplication.[optional]
nameStringFilename of the attachment if present[optional]
webhookIdUUIDID of webhook entity being triggered[optional]
webhookNameStringName of the webhook being triggered[optional]

Enum: EventNameEnum

NameValue
EMAIL_RECEIVED“EMAIL_RECEIVED”
NEW_EMAIL“NEW_EMAIL”
NEW_CONTACT“NEW_CONTACT”
NEW_ATTACHMENT“NEW_ATTACHMENT”
EMAIL_OPENED“EMAIL_OPENED”
EMAIL_READ“EMAIL_READ”