Skip to content

README lists the email.scheduled, email.failed and email.suppressed webhook events #10

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
heliocosta-dev merged 2 commits into from
Oct 17, 2026
Merged

README lists the email.scheduled, email.failed and email.suppressed webhook events #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b645a83
README lists the email.scheduled, email.failed and email.suppressed w…
heliocosta-dev Oct 17, 2026
f4898b5
README names the opt-in email.prefetched event and the email kept on …
heliocosta-dev Oct 17, 2026
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
25 changes: 18 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,18 +458,25 @@ During the overlap window (`overlap_hours`, 0–72, default 24) every delivery c
signatures, so a receiver holding either verifies; `Webhooks.get` reports the window's end
as `previous_secret_expires_at` (`nil` when none is open).

Events: `email.sent`, `email.delivered`, `email.delivery_delayed`, `email.bounced`,
`email.complained`, `email.opened`, `email.clicked`, `contact.created`, `contact.updated`,
Events: `email.scheduled`, `email.sent`, `email.delivered`, `email.delivery_delayed`,
`email.bounced`, `email.complained`, `email.failed`, `email.suppressed`, `email.opened`,
`email.clicked`, `email.prefetched`, `email.received`, `contact.created`, `contact.updated`,
`contact.deleted`, `contact.unsubscribed`, `contact.resubscribed`, `contact.topic_opt_in`,
`contact.topic_opt_out`, `suppression.added`, `suppression.removed`, `deliverability.warning`,
`deliverability.paused`, `quota.warning`, `quota.reached`, `quota.paused`, `email.received`, and
`deliverability.paused`, `quota.warning`, `quota.reached`, `quota.paused`, and
the inbox events `inbox.created`, `inbox.updated`, `inbox.deleted`, `inbox.expired`,
`inbox.thread.created`, `inbox.thread.folder.updated`, `inbox.thread.labels.updated`,
`inbox.email.received`, `inbox.email.sent`, `inbox.email.quarantined`, `inbox.draft.created`,
`inbox.draft.updated`, `inbox.draft.sent`, `inbox.draft.deleted`. Inbox events are opt-in: an
endpoint gets them only when its `events` list names them. A shared-domain inbox deleted after
90 unused days sends `inbox.expired`, then `inbox.deleted`, and inbox events from a send in the
dashboard carry `source: "dashboard"` in their `data`.
`inbox.draft.updated`, `inbox.draft.sent`, `inbox.draft.deleted`. `email.prefetched` and inbox
events are opt-in: an endpoint gets them only when its `events` list names them. A shared-domain
inbox deleted after 90 unused days sends `inbox.expired`, then `inbox.deleted`, and inbox events
from a send in the dashboard carry `source: "dashboard"` in their `data`.

`email.failed` says why in `data.failed.reason`, and `email.suppressed` in `data.suppressed`
(`type`, `message` and `reason`); those values are an open set, so treat them as strings, not a
closed enum. `suppression.added` and `suppression.removed` carry `data.source_id`, the email whose
bounce or complaint created the entry (`nil` otherwise). On servers before v0.15.1, a webhook that
names `email.scheduled`, `email.failed` or `email.suppressed` raises `ValidationError`.

### API keys

Expand Down Expand Up @@ -568,6 +575,9 @@ before v0.13.0 answered it with text, which raises `ApplicationError` with statu

`Emails.send` and `Batch.send` raise `AllRecipientsSuppressedError` (`all_recipients_suppressed`,
422) when every `to` recipient is on the suppression list or opted out of the send's `topic_id`.
An `Emails.send` that the suppression list alone refuses still keeps a metadata-only `suppressed`
email, which fires `email.suppressed`, and each retry keeps another, even with the same
`idempotency_key` (a refused send doesn't hold its key).

### Retries

Expand Down Expand Up @@ -597,6 +607,7 @@ On a self-hosted instance, each feature needs at least this MillionSend version:
| v0.12.0 | `username`; inboxes that never expire by default; sends from shared-domain inboxes; name review (`NameReviewUnavailableError`, the daily budget); `statusCode`/`name` on contacts-batch errors |
| v0.13.0 | Newest-first lists; `since` on `Codes.latest`; `quarantined` on thread items; inbox names up to 320 characters; `NotFoundError` at once for an unknown `inbox_id`; `unread` on inbox-scoped keys; JSON 404 for unknown routes |
| v0.14.0 | The shared row in `Domains.list` (`shared`, `sending_mode`, `sending_mode_reason`); `domain_id` on `Inboxes.create`; `subject` up to 998 characters |
| v0.15.1 | The `email.scheduled`, `email.failed` and `email.suppressed` webhook events; `source_id` on `suppression.added` and `suppression.removed`; a `suppressed` email kept on `AllRecipientsSuppressedError` |

An older server ignores options it doesn't know: before v0.14.0 `domain_id` (check the created
inbox's `email_address`), before v0.13.0 `since` (a code already used can come back), and before
Expand Down
Loading