docs(webhooks): document inbox/pod suspension + reactivation events#17
Open
armandokun wants to merge 3 commits into
Open
docs(webhooks): document inbox/pod suspension + reactivation events#17armandokun wants to merge 3 commits into
armandokun wants to merge 3 commits into
Conversation
Adds the reputation lifecycle webhook events (inbox.suspended, inbox.reactivated, pod.suspended, pod.reactivated) to the events reference: new entries in the events table, a dedicated reputation lifecycle payload example with field descriptions, and notes that these are HTTP-only and that the engine never auto-recovers a suspension. Updates the webhooks overview and page descriptions to mention lifecycle events alongside inbound email. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Match the API: drop the internal reputation object (scope/state/actor) and raw reason strings; document a single top-level `reason` with a stable public code table (high_bounce_rate, high_complaint_rate, abuse, pod_degraded, manual_review, other). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Match the API: these are delivery bookkeeping, not customer-facing fields. Receivers dedupe on event_id (X-Event-Id header). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Documents the new reputation lifecycle webhook events shipped in openmailsh/openmail#168.
Changes
pages/webhooks/events.mdx— addsinbox.suspended,inbox.reactivated,pod.suspended,pod.reactivatedto the events table; new "Reputation lifecycle payload" section with a full example + field descriptions (reputation.scope/state/reason/actor,inbox_address,pod_id); notes they're HTTP-only and that the engine never auto-recovers a suspension. Fixes the stale "currently always message.received" line.concepts/webhooks.mdx— overview now mentions lifecycle events alongside inbound email.Why
Integrators (e.g. AI-employee platforms) need to know when a specific end-user inbox/pod is suspended so they can react — without their whole account being affected. Pairs with the API change in openmailsh/openmail#168.
🤖 Generated with Claude Code