docs: add webhook event reference page - #93
Open
xikimay wants to merge 9 commits into
Open
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The frozen webhook schema is being re-cut to make data.expires_at non-null before any partner consumes it, aligning with the REST contract and pay-core, which always defaults expiry to 15 minutes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Same re-cut rationale as expires_at: reference_id is required at payment creation in core and in the REST contract, so the webhook schema is being tightened before any partner consumes it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Core only allows cancellation from requires_action, so the schema is being tightened to drop the cancelled-after-processing variant before any partner consumes the webhook. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Trims the stage-block details the reference now owns and points to it from the payload table and the next-steps cards. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
xikimay
marked this pull request as ready for review
July 31, 2026 16:22
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
Adds Webhook event reference (
payments/webhook-event-reference), the field-level contract of the payment webhook payload (api_version 2026-05-18): envelope and payment-snapshot tables with types and nullability, a stage-object presence matrix per event type, per-object field tables, and one example per event type.docs.jsonnavigation until the webhooks feature rolls out; reachable by URL, likepayments/webhooks. At rollout, add both pages to the merchant group together.Merge after #92, which corrects two statements on the guide this page relies on.
🤖 Generated with Claude Code