docs: document message.complained and message.suppressed webhook events - #18
Merged
Conversation
Add the two delivery-outcome webhook events to the subscribable event lists so users know how to handle them: - message.complained: the recipient marked the message as spam. A complaint emits both message.complained and message.opted_out, so existing opt-out handlers keep working unchanged. - message.suppressed: a send was skipped because the address failed validation or was already on the suppression list after an earlier bounce or complaint.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two delivery-outcome webhook events that the platform emits weren't reflected in the SDK docs. This documents them so users know the events exist and how to handle them. Docs-only — no code changes. Mirrors the same update in the JS and PHP SDKs.
Added the two missing events to the "Subscribable event types" list in
README.md:message.complained— the recipient marked the message as spam. A complaint emits bothmessage.complainedandmessage.opted_out, so handlers that only watch for opt-outs keep working unchanged.message.suppressed— a send was skipped because the address failed validation or was already on the suppression list after an earlier bounce or complaint.The
WebhookVerifieralready passesevent.typethrough as a free-form string, so no code change is required.Related issues
None.
Checklist
ruff/mypy/pytest— n/a, no code touchedGenerated by Claude Code