Skip to content

docs: document message.complained and message.suppressed webhook events #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tuyakhov merged 1 commit into from
Jul 31, 2026
Merged

docs: document message.complained and message.suppressed webhook events #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,9 +320,14 @@ print(event.type, event.payload) # e.g. "message.delivered", {...}
```

Subscribable event types: `message.sent`, `message.delivered`, `message.failed`,
`message.opted_out`, `message.opened`, and `message.clicked`. The engagement
events (`message.opened` / `message.clicked`) never change a message's status,
and the `message.clicked` payload also carries the clicked `link`.
`message.opted_out`, `message.complained`, `message.suppressed`, `message.opened`,
and `message.clicked`. `message.complained` fires when the recipient marks the
message as spam; a complaint emits both `message.complained` and `message.opted_out`,
so handlers that only watch for opt-outs keep working unchanged. `message.suppressed`
fires when a send is skipped because the address failed validation or was already on
the suppression list after an earlier bounce or complaint. The engagement events
(`message.opened` / `message.clicked`) never change a message's status, and the
`message.clicked` payload also carries the clicked `link`.

The framework integrations below wire this up for you.

Expand Down