Skip to content

Interface: WebhookBouncePayload

BOUNCE webhook payload. Sent to your webhook url endpoint via HTTP POST when an email bounced or was rejected by a recipient. Save the recipients to a ban list on your server and avoid emailing them again. It is recommended you also listen to the BOUNCE_RECIPIENT payload.

export

interface WebhookBouncePayload

Table of contents

Properties

Properties

bounceId

bounceId: string

ID of the bounce email record. Use the ID with the bounce controller to view more information

memberof WebhookBouncePayload


bounceRecipients

Optional bounceRecipients: string[]

Email addresses that resulted in a bounce or email being rejected. Please save these recipients and avoid emailing them in the future to maintain your reputation.

memberof WebhookBouncePayload


eventName

eventName: WebhookBouncePayloadEventNameEnum

Name of the event type webhook is being triggered for.

memberof WebhookBouncePayload


messageId

messageId: string

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

memberof WebhookBouncePayload


sender

sender: string

Sender causing bounce

memberof WebhookBouncePayload


sentToRecipients

Optional sentToRecipients: string[]

Email sent to recipients

memberof WebhookBouncePayload


webhookId

webhookId: string

ID of webhook entity being triggered

memberof WebhookBouncePayload


webhookName

Optional webhookName: string

Name of the webhook being triggered

memberof WebhookBouncePayload