docs: add webhook payload and retry behavior reference - #559
Open
BABAT-CODE wants to merge 1 commit into
Open
Conversation
Add docs/webhooks.md covering the full webhook integration surface: - All four event types with exact payload shapes: invoice_paid, settlement_proposed, settlement_approved, settlement_executed. - Common envelope fields (event_type, idempotency_key, timestamp, invoice_id, settlement_id, data) documented in a shared table. - Signature verification section with algorithm summary, header reference table, and working Node.js and Python code samples using constant-time comparison as required. - Idempotency section explaining the deterministic key format (<event_type>:<id>) and how to use it to safely deduplicate retries. - Delivery guarantees section with the full retry schedule table (5 attempts, 1s base delay, 2^n backoff, 10s request timeout), delivery record field reference, and guidance on how to respond. - Troubleshooting table covering the most common integration mistakes. Also update docs/api-reference.md to add a 'see also' link to the new reference page from the existing Webhooks section. Verified: npx markdownlint-cli2 docs/**/*.md *.md reports zero new issues in docs/webhooks.md or the updated docs/api-reference.md. Closes WHEELBACK#4
|
@BABAT-CODE Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
Add docs/webhooks.md covering the full webhook integration surface:
Also update docs/api-reference.md to add a 'see also' link to the new reference page from the existing Webhooks section.
Verified: npx markdownlint-cli2 docs/**/*.md *.md reports zero new issues in docs/webhooks.md or the updated docs/api-reference.md.
Pull Request
Summary
Checklist
abis/andCOMEBACKHERE-contracts/)Notes
make check-abi-snapshots.closes docs: document webhook payload schemas and retry/backoff behavior #471