Message Suppressed Webhook

POST

message.suppressed

Body

application/json

type

enum<string>

required

The event type

Available options:

message.suppressed

webhook_id

string<uuid>

required

The webhook ID (the same ID as returned by the Create Webhook API)

timestamp

string<date-time>

required

When the event occurred (ISO 8601 format)

data

object

required

Show child attributes

data.account_id

string<uuid>

required

Account ID that sent the message

data.event

enum<string>

required

The specific event that occurred

Available options:

on_reception,

on_delivered,

on_transient_error,

on_failed,

on_bounced,

on_suppressed,

on_opened,

on_clicked

data.from

string<email>

required

Sender email address

data.recipient

string<email>

required

Recipient email address

data.subject

string

required

Email subject line

data.message_id_header

string

required

Message ID header (same as returned by the Create Message API)

data.id

string

required

Internal AhaSend message ID

data.user_agent

string

User agent (only for opened/clicked events)

data.ip

string

IP address (only for opened/clicked events)

data.is_bot

boolean

Whether the action was performed by a bot

Response

Webhook received successfully

Bounced Opened

⌘I

Overview

API reference

Webhooks

Message Routing

API v1 (legacy)

Message Suppressed Webhook

Body

Response