Repository navigation
[Documentation] docs/webhooks.md documents non-existent '/api/webhooks/subscriptions' endpoints and outdated payload schema #2030
Description
Issue #150
docs/webhooks.md Documents Non-Existent '/api/webhooks/subscriptions' Endpoints and Outdated Payload Schema
- Title:
[Documentation] docs/webhooks.md documents non-existent '/api/webhooks/subscriptions' endpoints and outdated payload schema - Labels:
documentation, backend, good first issue - Location:
docs/webhooks.md:23-73, 165-271,backend/src/routes/indexerRoutes.ts:304-465,backend/src/schemas/indexerSchemas.ts:62-75,backend/src/services/webhookService.ts:15-26 - Description:
docs/webhooks.mdis out of sync with the actual webhook implementation in the backend:- It documents
/api/webhooks/subscriptionsendpoints instead of the actual/api/indexer/webhooks/subscribe,GET /api/indexer/webhooks,DELETE /api/indexer/webhooks/:subscriptionId, andPOST /api/indexer/webhooks/:subscriptionId/replay-dlqroutes. - It documents
{ url, events, description }instead ofwebhookSubscribeSchema's{ callbackUrl, eventTypes, secret }. - It documents a nested
{ event, id, timestamp, data }payload and 10s/8-attempt retry config instead of the flatWebhookPayloadstructure and 30s/5-attempt config inwebhookService.ts.
- It documents
- Impact:
External integrators followingdocs/webhooks.mdhit 404 Not Found on every webhook management endpoint, 400 Validation Error on subscription creation, and fail to parse incoming webhook payloads. - Suggested Fix:
Updatedocs/webhooks.mdto document the actual/api/indexer/webhooks/*endpoints, the{ callbackUrl, eventTypes, secret }request schema, the flatWebhookPayloaddelivery structure, and the actual retry/timeout constants frombackend/src/services/webhookService.ts.
Activity
ranjeetprabhatedu-dotcom commentedon Oct 18, 2026
Hello maintainers,
I reviewed "[Documentation] docs/webhooks.md documents non-existent '/api/webhooks/subscriptions' endpoints and outdated payload schema" and would like to work on this.
I have reviewed the problem description and acceptance criteria for this issue. I have a clear, tested implementation ready with defensive error handling and 100% green CI proof.
I will deliver a clean, well-tested, and production-ready PR promptly upon assignment. Kindly assign this issue to me.
Thank you!
harmondconsultant-png commentedon Oct 18, 2026
@harmondconsultant-png has applied to work on this issue as part of the Stellar Wave Program's 10th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @harmondconsultant-png to this issue.
bade2brazy commentedon Oct 18, 2026
@bade2brazy has applied to work on this issue as part of the Stellar Wave Program's 10th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @bade2brazy to this issue.
cyberdocs120 commentedon Oct 18, 2026
@cyberdocs120 has applied to work on this issue as part of the Stellar Wave Program's 10th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @cyberdocs120 to this issue.
drips-wave commentedon Oct 18, 2026
Congratulations, @bade2brazy! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on October 22, 2026.
🧑💻 @bade2brazy: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.
Warning
When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.
🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.
🌊 Happy Wave 🌊
bade2brazy commentedon Oct 18, 2026
Resolved in PR #2032. Updated
docs/webhooks.mdto document actual/api/indexer/webhooksroutes,{ callbackUrl, eventTypes, secret }schema, flatIndexedLoanEventpayload examples, and 30s/4-attempt retry semantics.docs: update webhooks guide with actual endpoints, schema, and retry …
drips-wave commentedon Oct 18, 2026
This issue has been completed by @bade2brazy as part of the Stellar Wave Program's 10th Wave 🥳
😎 @bade2brazy: You earned 200 Points for completing this issue! Once the Wave's rewards are finalized, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.
🧑💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.