Skip to content

docs: document the secure_payment.user_event webhook - #114

Open
rodrigopavezi wants to merge 2 commits into
mainfrom
docs/secure-payment-user-event-webhook
Open

docs: document the secure_payment.user_event webhook#114
rodrigopavezi wants to merge 2 commits into
mainfrom
docs/secure-payment-user-event-webhook

Conversation

@rodrigopavezi

Copy link
Copy Markdown
Contributor

Part of REQ-291

Documents the new secure_payment.user_event webhook.

Implementation: RequestNetwork/request-api#1139 · UI: RequestNetwork/request-secure-payment#550
Merge after the API PR ships, so the docs don't describe an event platforms aren't receiving yet.

What's documented

  • api-reference/webhooks.mdx — a "Secure Payment Page Events (payer funnel)" section: the event table row, the three userEvent values (wallet_connected, payment_sent_to_wallet, payment_approved_in_wallet), a payload example, and a note on field semantics
  • api-features/webhooks-events.mdx — new category row, and the event-type count bumped 12 → 13

Signature verification, delivery headers and retry behaviour are unchanged, so the existing guidance on this page applies as-is and isn't restated.

Points worth a reviewer's eye

  • The payload example was checked field-by-field against what the service actually emits, including optionality.
  • The note draws a deliberate line between server-derived fields (securePaymentToken, requestId/requestIds, orchestratorId, timestamp) and client-reported telemetry (occurredAt, properties) — integrators should not treat properties as authoritative, since it originates in the payer's browser.
  • It also states that wallet addresses appear only as sha256 hashes, which holds for these three events.

Scope is limited to this one event; other currently-undocumented events (client_id.linked, secure_payment.access_rejected, kyt.screening.completed) are left alone.

Documents the new payer-funnel webhook emitted by the Secure Payment Page:
the three userEvent values (wallet_connected, payment_sent_to_wallet,
payment_approved_in_wallet), a payload example, and the field semantics --
notably that occurredAt and properties are client-reported telemetry and that
wallet addresses appear only as hashes.

Signature verification, delivery headers and retry behaviour are unchanged, so
the existing guidance applies as-is.
@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
request-network 🟢 Ready View Preview Aug 6, 2026, 12:31 AM

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

@greptile-apps

greptile-apps Bot commented Aug 6, 2026

Copy link
Copy Markdown

Greptile Summary

The PR documents the new secure_payment.user_event webhook and updates the previously stale complete-event catalogs.

  • Adds the event’s payer-funnel semantics, supported userEvent values, payload example, and trust boundaries.
  • Updates the quickstart and reconciliation guide to include the thirteenth event.
  • Adds an illustrative reconciliation branch that records funnel telemetry without treating it as settlement.

Confidence Score: 5/5

The PR appears safe to merge after the dependent API implementation ships.

No blocking failure remains; the previously reported stale quickstart and reconciliation catalogs now both include secure_payment.user_event.

Important Files Changed

Filename Overview
api-features/webhooks-events.mdx Updates the catalog count and adds the Secure Payment Page event category and payer-funnel use case.
api-reference/webhooks.mdx Documents the new event’s values, payload, delivery behavior, and distinction between server-derived and client-reported fields.
use-cases/quickstart.mdx Adds secure_payment.user_event to the quickstart’s supported-event table and clearly identifies it as non-settlement telemetry.
use-cases/webhook-reconciliation.mdx Completes the thirteen-event catalog and adds a reconciliation example that records funnel steps without changing payment state.

Reviews (2): Last reviewed commit: "docs: add the new event to the reconcili..." | Re-trigger Greptile

Comment thread api-features/webhooks-events.mdx
Both guides present their event lists as complete -- "The 12 events" and
"All supported webhook events" -- so leaving them untouched would have told
integrators the payer-funnel event does not exist.

Adds `secure_payment.user_event` to both tables, bumps the reconciliation
heading to 13, and adds a handler case to the reconciliation switch example
with an explicit warning not to reconcile money off it: a payer can approve in
their wallet and the transaction can still fail on-chain, so payment.confirmed
remains the settlement signal.
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