Skip to content

chore: consolidate webhook guidance - #130

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

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

Webhook documentation does not give an orchestrator integrator one clear, current path for registering an endpoint, understanding which events it receives, and reading the payload.

Relevant guidance is split between the main reference and the older Orchestrator page. Legacy API events also appear alongside current Secure Payment and orchestrator events, making it hard to tell what applies to a new integration.

REQ-420

Proposed Solution

  • Give platform and orchestrator integrations one technical reference for endpoint setup, event recipients, and payload identities.
  • Present current Secure Payment and orchestrator events first, with older API-only events in a separate Legacy integrations section.
  • Point the Quickstart and related orchestrator pages to the relevant setup guidance instead of duplicating it.
  • Make the required credentials clear: an orchestrator key manages its endpoints; paired authentication creates a Secure Payment for a linked platform.

Design Rationale

  • A webhook endpoint receives every event available to its Client ID or orchestrator. There is no per-event subscription setting.
  • The former Orchestrator webhooks page redirects to the technical reference so endpoint setup and event routing do not drift between pages.
  • The reference keeps platform-only events visible while separating older API integrations from the current Secure Payment and orchestrator path.

Considerations

  • mintlify-docs#131 already added the current client_id.linked and kyt.screening.completed payload examples under REQ-455.
  • This documentation depends on the pending delivery and identity changes in request-api#1155, request-api#1156, request-api#1158, and request-api#1159. It should merge only after the corresponding API behavior is available.
  • This PR documents the current API; it does not change webhook delivery. payment.failed and secure_payment.access_rejected remain platform-only. Partial payments, refunds, crypto-to-fiat events, compliance and bank updates, and recurring requests remain legacy API integrations.

UAT

  1. Open the preview Webhooks reference and confirm that it distinguishes platform and orchestrator endpoint setup.
  2. Confirm that the current event catalog appears before Legacy integrations, and that legacy-only events are clearly separated.
  3. Open the preview Quickstart and confirm that its webhook step links to the reference instead of repeating the setup guide.
  4. Open the Orchestrators overview and Client ID linking; their webhook links should lead to the orchestrator setup section.
  5. Open /orchestrators/webhooks; it should redirect to the canonical 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 platform and orchestrator webhook documentation into one canonical reference.

  • Adds orchestrator registration, authentication, recipient-routing, and event-contract guidance.
  • Redirects the retired orchestrator webhook page and updates related navigation.
  • Aligns webhook catalogs, payload identities, test-delivery handling, and settlement guidance.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
api-reference/webhooks.mdx Consolidates registration, recipient routing, event catalogs, payload identities, delivery requirements, and retry guidance.
use-cases/webhook-reconciliation.mdx Expands the shared webhook handling flow for platform and orchestrator events and adds safe test-delivery handling.
docs.json Redirects the retired orchestrator webhook route to the consolidated reference and removes the obsolete navigation entry.
orchestrators/webhooks.mdx Removes the superseded standalone orchestrator webhook page.
api-features/webhooks-events.mdx Aligns the overview catalog and routing language with the consolidated webhook reference.

Reviews (11): 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
Comment thread api-reference/webhooks.mdx
@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
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from 40367e7 to d151d00 Compare August 25, 2026 16:29
@MantisClone
MantisClone changed the base branch from graphite-base/130 to 08-25-chore_add_webhook_payload_examples August 25, 2026 16:29
@MantisClone
MantisClone force-pushed the 08-25-chore_add_webhook_payload_examples branch from a606404 to 49f27d8 Compare August 25, 2026 16:32
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from d151d00 to bf18b62 Compare August 25, 2026 16:32
@MantisClone
MantisClone changed the base branch from 08-25-chore_add_webhook_payload_examples to graphite-base/130 August 25, 2026 16:43
@MantisClone
MantisClone force-pushed the 08-25-chore_consolidate_webhook_guidance branch from bf18b62 to ea53337 Compare August 25, 2026 16:43
@MantisClone
MantisClone changed the base branch from graphite-base/130 to fix/REQ-350-remove-unused-webhook-events August 25, 2026 16:43
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
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.

1 participant