Skip to content

fix: remove unused webhook event variants - #129

Merged
MantisClone merged 1 commit into
mainfrom
fix/REQ-350-remove-unused-webhook-events
Aug 25, 2026
Merged

fix: remove unused webhook event variants#129
MantisClone merged 1 commit into
mainfrom
fix/REQ-350-remove-unused-webhook-events

Conversation

@MantisClone

@MantisClone MantisClone commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Problem

The public docs list four payment webhook variants that Request Network never emits. That can lead you to build handlers for notifications that will never arrive.

REQ-350

Proposed Solution

  • Remove the obsolete Client ID- and checkout-scoped payment variants from the webhook catalog, reference, Quickstart, and reconciliation guide.
  • Update the catalog counts and handler example to match the supported events.

Considerations

UAT

  1. Open the Mintlify preview for this PR.
  2. Check the webhook catalog, reference, Quickstart, and reconciliation guide.
  3. Confirm that the four removed payment.confirmed.* and payment.partial.* variants are absent, and the catalog lists 10 supported events.

@mintlify

mintlify Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
request-network 🟢 Ready View Preview Aug 21, 2026, 10:29 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

MantisClone commented Aug 21, 2026

Copy link
Copy Markdown
Contributor Author

@greptile-apps

greptile-apps Bot commented Aug 21, 2026

Copy link
Copy Markdown

Greptile Summary

This PR removes four webhook event variants that Request Network does not emit and aligns the public documentation with the 10 supported events.

  • Removes Client ID- and checkout-scoped payment variants from the webhook catalog and reference.
  • Updates the Quickstart and reconciliation event lists.
  • Simplifies the reconciliation handler to process only emitted payment events.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains; the previously reported stale scoped-variant references have been removed from the current documentation.

Important Files Changed

Filename Overview
api-features/webhooks-events.mdx Removes the four obsolete variants and updates the catalog from 14 to 10 events.
api-reference/webhooks.mdx Removes obsolete scoped-event sections and fixes the stale payload-field references identified previously.
use-cases/quickstart.mdx Removes unsupported event variants from payment-link guidance and the event table.
use-cases/webhook-reconciliation.mdx Updates the event count and removes unsupported variants from both the catalog and handler example.

Reviews (3): Last reviewed commit: "fix: remove unused webhook event variant..." | Re-trigger Greptile

Comment thread api-reference/webhooks.mdx
@MantisClone
MantisClone force-pushed the fix/REQ-350-remove-unused-webhook-events branch from c6195cf to 601be1a Compare August 21, 2026 22:37
@MantisClone
MantisClone marked this pull request as ready for review August 21, 2026 22:40
@MantisClone
MantisClone changed the base branch from main to graphite-base/129 August 25, 2026 16:43
@MantisClone
MantisClone force-pushed the fix/REQ-350-remove-unused-webhook-events branch from 601be1a to 727f200 Compare August 25, 2026 16:43
@MantisClone
MantisClone changed the base branch from graphite-base/129 to 08-25-chore_add_webhook_payload_examples August 25, 2026 16:43

MantisClone commented Aug 25, 2026

Copy link
Copy Markdown
Contributor Author

Merge activity

  • Aug 25, 5:12 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Aug 25, 5:14 PM UTC: Graphite rebased this pull request as part of a merge.
  • Aug 25, 5:14 PM UTC: @MantisClone merged this pull request with Graphite.

@MantisClone
MantisClone changed the base branch from 08-25-chore_add_webhook_payload_examples to graphite-base/129 August 25, 2026 17:12
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 graphite-base/129 to main August 25, 2026 17:12
@MantisClone
MantisClone force-pushed the fix/REQ-350-remove-unused-webhook-events branch from 727f200 to 9657432 Compare August 25, 2026 17:13
@MantisClone
MantisClone merged commit f76b7e0 into main Aug 25, 2026
2 checks passed
@MantisClone
MantisClone deleted the fix/REQ-350-remove-unused-webhook-events branch August 25, 2026 17:14
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