chore: consolidate webhook guidance - #130
Conversation
eb1b5ff to
6a7bb91
Compare
Greptile SummaryThe PR consolidates orchestrator webhook registration and endpoint-management guidance into the main webhook reference, redirects the former page, and updates orchestrator documentation links.
Confidence Score: 3/5The PR is not yet safe to merge because the canonical Express webhook example still processes test deliveries as real events and invokes undefined business handlers. The consolidation itself preserves the intended routes and content, but previously reported blocking defects remain in the destination page: checking the test header does not stop placeholder events from reaching business logic, and the copied Express example fails when its undefined handlers are invoked. Files Needing Attention: api-reference/webhooks.mdx Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart LR
Old["/orchestrators/webhooks"] -->|redirect| Reference["/api-reference/webhooks"]
Overview["Orchestrator overview"] --> Reference
Linking["Client ID linking"] --> Reference
KYT["KYT plans"] --> Reference
Reference --> Setup["Registration and endpoint management"]
Reference --> Payloads["client_id.linked and kyt.screening.completed payloads"]
Reviews (12): Last reviewed commit: "chore: consolidate webhook guidance" | Re-trigger Greptile |
6a7bb91 to
c5598a5
Compare
c5598a5 to
ffad3f5
Compare
ffad3f5 to
2eea0f4
Compare
2eea0f4 to
4e1c1d2
Compare
d9ab559 to
304f08a
Compare
c8c1359 to
1b35f7b
Compare
1b35f7b to
9cbba62
Compare
9cbba62 to
40367e7
Compare
# Problem Yorvi (aka. Cheetah) needs current webhook payload examples in the main public documentation. The Client ID linking and KYT examples are only available in a separate orchestrator guide, while payment confirmation and Secure Payment Page examples are already on the main Webhooks page. [REQ-455](https://linear.app/requestnetwork/issue/REQ-455/mintlify-docs-add-current-cheetah-webhook-payload-examples) # Proposed Solution - Add the current `client_id.linked` payload example to the main Webhooks reference. - Add the current `kyt.screening.completed` payload example to the same reference. - Leave endpoint registration, event routing, and the existing orchestrator guide unchanged. # Considerations - This PR documents current payloads only. The broader Client ID/orchestrator delivery and identity guidance is in #130. - #129 stacks on this PR. # UAT 1. Open the [Mintlify preview](https://requestnetwork-08-25-chore-add-webhook-payload-examples.mintlify.site/api-reference/webhooks#payload-examples). 2. Confirm it includes examples for `client_id.linked` and `payment.confirmed`. 3. Confirm the [KYT screening payload](https://requestnetwork-08-25-chore-add-webhook-payload-examples.mintlify.site/api-reference/webhooks#kyt-screening-completed) includes `kyt.screening.completed`. 4. Confirm the [Secure Payment user-event payload](https://requestnetwork-08-25-chore-add-webhook-payload-examples.mintlify.site/api-reference/webhooks#secure-payment-user-event) remains available. 5. Confirm the existing payment-confirmation and Secure Payment Page examples remain unchanged.
727f200 to
f76b7e0
Compare
ea53337 to
97eb939
Compare
97eb939 to
48c045a
Compare
48c045a to
ff99712
Compare
ff99712 to
9f74eb5
Compare
b6c6efc to
bdf0010
Compare
bdf0010 to
68e4010
Compare
68e4010 to
614ca27
Compare

Problem
Orchestrator webhook setup is documented separately from the main webhook reference.
This makes an orchestrator switch pages to register, test, and manage an endpoint. The overview, Client ID linking, and KYT plans guides all point to that separate page.
REQ-420
Proposed Solution
Design Rationale
The Webhooks reference is the single technical page for registering and managing endpoints. Keeping orchestrator setup there avoids duplicate instructions while leaving the existing platform webhook guidance unchanged.
Considerations
UAT
x-orchestrator-key.