Skip to content

chore: consolidate webhook guidance - #130

Open
MantisClone wants to merge 1 commit into
mainfrom
08-25-chore_consolidate_webhook_guidance
Open

chore: consolidate webhook guidance#130
MantisClone wants to merge 1 commit into
mainfrom
08-25-chore_consolidate_webhook_guidance

Conversation

@MantisClone

@MantisClone MantisClone commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

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

  • Add orchestrator endpoint setup and management to the Webhooks reference.
  • Redirect the former Orchestrator webhooks page to that reference and remove it from navigation.
  • Link the relevant orchestrator guides directly to the new section and its payload examples.

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

  • This PR covers only the original documentation consolidation. Current routing and delivery behavior, the legacy-event catalog, the reconciliation guide, and the Quickstart cleanup are deliberately deferred to stacked follow-up PRs.
  • This PR does not change webhook delivery or payloads.

UAT

  1. Open the preview Webhooks reference and confirm that the Orchestrator webhooks section covers registration, testing, listing, deactivation, and reactivation with x-orchestrator-key.
  2. Open the Orchestrators overview, Client ID linking, and KYT plans. Their webhook links should lead to the relevant reference section or payload example.
  3. Open the former Orchestrator webhooks route; it should redirect to the Webhooks reference.

MantisClone commented Aug 24, 2026

Copy link
Copy Markdown
Contributor Author

@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch 2 times, most recently from eb1b5ff to 6a7bb91 Compare August 24, 2026 23:52
@greptile-apps

greptile-apps Bot commented Aug 24, 2026

Copy link
Copy Markdown

Greptile Summary

The PR consolidates orchestrator webhook registration and endpoint-management guidance into the main webhook reference, redirects the former page, and updates orchestrator documentation links.

  • Adds orchestrator registration, testing, deactivation, and reactivation instructions.
  • Redirects /orchestrators/webhooks to the consolidated reference and removes the old page from navigation.
  • Updates overview, Client ID linking, and KYT links to target the consolidated sections and payload examples.

Confidence Score: 3/5

The 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

Filename Overview
api-reference/webhooks.mdx Consolidates orchestrator webhook guidance successfully, but previously reported defects in the existing Express receiver example remain outstanding.
docs.json Adds a relevant redirect for the deleted orchestrator webhook page and removes that page from navigation.
orchestrators/client-id-linking.mdx Updates setup and event links to valid sections of the consolidated webhook reference.
orchestrators/kyt-plans.mdx Retargets webhook guidance and KYT payload links to valid consolidated-page anchors.
orchestrators/overview.mdx Updates orchestrator webhook references to the new canonical section.
orchestrators/webhooks.mdx Removes the superseded standalone page after its guidance is consolidated and redirected.

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"]
Loading

Reviews (12): Last reviewed commit: "chore: consolidate webhook guidance" | Re-trigger Greptile

Comment thread api-reference/webhooks.mdx Outdated
Comment thread api-reference/webhooks.mdx Outdated
Comment thread api-reference/webhooks.mdx Outdated
Comment thread api-reference/webhooks.mdx Outdated
Comment thread api-reference/webhooks.mdx Outdated
@MantisClone
MantisClone requested a deployment to Preview August 25, 2026 02:26 Abandoned
@MantisClone
MantisClone requested a deployment to Preview August 25, 2026 02:26 Abandoned
@MantisClone
MantisClone requested a deployment to Preview August 25, 2026 02:26 Abandoned
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from 2eea0f4 to 4e1c1d2 Compare August 25, 2026 02:31
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch 2 times, most recently from d9ab559 to 304f08a Compare August 25, 2026 03:04
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch 2 times, most recently from c8c1359 to 1b35f7b Compare August 25, 2026 03:16
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from 1b35f7b to 9cbba62 Compare August 25, 2026 03:23
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from 9cbba62 to 40367e7 Compare August 25, 2026 03:40
MantisClone added a commit that referenced this pull request Aug 25, 2026
# 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.
@MantisClone
MantisClone changed the base branch from fix/REQ-350-remove-unused-webhook-events to graphite-base/130 August 25, 2026 17:13
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from ea53337 to 97eb939 Compare August 25, 2026 17:14
@graphite-app
graphite-app Bot changed the base branch from graphite-base/130 to main August 25, 2026 17:15
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from 97eb939 to 48c045a Compare August 25, 2026 17:15
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from 48c045a to ff99712 Compare August 25, 2026 17:57
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from ff99712 to 9f74eb5 Compare August 25, 2026 19:13
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch 2 times, most recently from b6c6efc to bdf0010 Compare August 26, 2026 21:16
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from bdf0010 to 68e4010 Compare August 26, 2026 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants