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

Hierarchy

  • WebhookBouncePayload

Properties

bounceId bounceRecipients? eventName messageId sender sentToRecipients? webhookId webhookName?

Properties

bounceId

bounceId: string

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

Memberof

WebhookBouncePayload

Optional bounceRecipients

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

Optional sentToRecipients

sentToRecipients?: string[]

Email sent to recipients

Memberof

WebhookBouncePayload

webhookId

webhookId: string

ID of webhook entity being triggered

Memberof

WebhookBouncePayload

Optional webhookName

webhookName?: string

Name of the webhook being triggered

Memberof

WebhookBouncePayload

Settings

Member Visibility

Theme