docs: update card webhook documentation for CARD_TRANSACTION events#693
docs: update card webhook documentation for CARD_TRANSACTION events#693claude[bot] wants to merge 1 commit into
Conversation
The CARD_TRANSACTION webhook contract was added in cd9cb0c but documentation still referenced the "generic transaction webhook stream" and a "follow-up PR". This updates all outdated references. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
✱ Stainless preview builds for gridThis PR will update the cli go kotlin openapi php python ruby typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-typescript studio · code · diff
✅ grid-openapi studio · code · diff
✅ grid-ruby studio · code · diff
✅ grid-go studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-python studio · code · diff
✅ grid-php studio · code · diff
✅ grid-cli studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Greptile SummaryThis PR syncs documentation with the
Confidence Score: 3/5The webhooks page ships with a paragraph explicitly telling readers card-transaction events are NOT card webhooks, directly contradicting the new CARD_TRANSACTION.* section added in the same PR. The OpenAPI description updates and retry-policy table additions are accurate and consistent. However, webhooks.mdx still contains the old placeholder paragraph (lines 7–9) that flatly contradicts the new CARD_TRANSACTION.* section added just below it — a developer reading top-to-bottom receives contradictory information. mintlify/snippets/cards/webhooks.mdx — the stale placeholder paragraph (lines 7–9) must be removed before merging.
|
| Filename | Overview |
|---|---|
| mintlify/snippets/cards/webhooks.mdx | Adds CARD_TRANSACTION.* event table and updates intro label, but the old placeholder paragraph (lines 7–9) explicitly saying these events are NOT card webhooks was not removed and now directly contradicts the new section; the intro also still says "two webhook event types". |
| mintlify/snippets/cards/reconciliation.mdx | Status-transitions paragraph correctly updated to reference CARD_TRANSACTION.* webhooks; EXCEPTION path section (line 64) still uses old "transaction webhook" language and should reference CARD_TRANSACTION.EXCEPTION. |
| mintlify/snippets/webhooks.mdx | Adds CARD.* and CARD_TRANSACTION.* rows to the retry policy table with the standard policy; change is accurate and consistent with existing rows. |
| openapi/components/schemas/cards/CardTransaction.yaml | Description updated from "generic transaction webhook stream" to "CARD_TRANSACTION.* webhooks on every status transition" — accurate and concise. |
| openapi.yaml | Mirrors the CardTransaction.yaml description update in the bundled OpenAPI spec; change is correct. |
| mintlify/openapi.yaml | Same description update as openapi.yaml; kept in sync correctly. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
AUTH[AUTHORIZED\nCARD_TRANSACTION.AUTHORIZED] --> PS[PARTIALLY_SETTLED\nCARD_TRANSACTION.PARTIALLY_SETTLED]
AUTH --> EX[EXCEPTION\nCARD_TRANSACTION.EXCEPTION]
PS --> S[SETTLED\nCARD_TRANSACTION.SETTLED]
S --> R[REFUNDED\nCARD_TRANSACTION.REFUNDED]
PS --> R
style AUTH fill:#d4edda,stroke:#28a745
style PS fill:#fff3cd,stroke:#ffc107
style S fill:#cce5ff,stroke:#004085
style R fill:#e2d9f3,stroke:#6f42c1
style EX fill:#f8d7da,stroke:#dc3545
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
AUTH[AUTHORIZED\nCARD_TRANSACTION.AUTHORIZED] --> PS[PARTIALLY_SETTLED\nCARD_TRANSACTION.PARTIALLY_SETTLED]
AUTH --> EX[EXCEPTION\nCARD_TRANSACTION.EXCEPTION]
PS --> S[SETTLED\nCARD_TRANSACTION.SETTLED]
S --> R[REFUNDED\nCARD_TRANSACTION.REFUNDED]
PS --> R
style AUTH fill:#d4edda,stroke:#28a745
style PS fill:#fff3cd,stroke:#ffc107
style S fill:#cce5ff,stroke:#004085
style R fill:#e2d9f3,stroke:#6f42c1
style EX fill:#f8d7da,stroke:#dc3545
Comments Outside Diff (3)
-
mintlify/snippets/cards/webhooks.mdx, line 7-9 (link)Stale intro paragraph contradicts new CARD_TRANSACTION. section*
Lines 7–9 still say "Card-transaction lifecycle events are not card-specific webhooks — they ride on the generic transaction webhook stream (a follow-up extends the Transaction model with a card destination type)." This sentence now directly contradicts the
CARD_TRANSACTION.*section added later in the same file. A reader scrolling top-to-bottom will be told these events are not card webhooks, then immediately see a card webhook table for them.This paragraph was the placeholder for the follow-up work; it should be removed now that the follow-up has landed.
Context Used: mintlify/AGENTS.md (source)
Prompt To Fix With AI
This is a comment left during a code review. Path: mintlify/snippets/cards/webhooks.mdx Line: 7-9 Comment: **Stale intro paragraph contradicts new CARD_TRANSACTION.* section** Lines 7–9 still say "Card-transaction lifecycle events are not card-specific webhooks — they ride on the generic transaction webhook stream (a follow-up extends the Transaction model with a card destination type)." This sentence now directly contradicts the `CARD_TRANSACTION.*` section added later in the same file. A reader scrolling top-to-bottom will be told these events are *not* card webhooks, then immediately see a card webhook table for them. This paragraph was the placeholder for the follow-up work; it should be removed now that the follow-up has landed. **Context Used:** mintlify/AGENTS.md ([source](https://app.greptile.com/lightspark/github/lightsparkdev/grid-api/-/custom-context?memory=51934046-75fb-42d3-9870-f42d61cb60e3)) How can I resolve this? If you propose a fix, please make it concise.
-
mintlify/snippets/cards/webhooks.mdx, line 1 (link)Outdated "two webhook event types" count in the intro
The opening sentence says "Cards add two webhook event types" but this PR documents five additional
CARD_TRANSACTION.*events, bringing the total to seven. The count will mislead readers before they reach the event table.Context Used: mintlify/AGENTS.md (source)
Prompt To Fix With AI
This is a comment left during a code review. Path: mintlify/snippets/cards/webhooks.mdx Line: 1 Comment: **Outdated "two webhook event types" count in the intro** The opening sentence says "Cards add *two* webhook event types" but this PR documents five additional `CARD_TRANSACTION.*` events, bringing the total to seven. The count will mislead readers before they reach the event table. **Context Used:** mintlify/AGENTS.md ([source](https://app.greptile.com/lightspark/github/lightsparkdev/grid-api/-/custom-context?memory=51934046-75fb-42d3-9870-f42d61cb60e3)) How can I resolve this? If you propose a fix, please make it concise.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
-
mintlify/snippets/cards/reconciliation.mdx, line 64-67 (link)Stale "transaction webhook" phrasing in the EXCEPTION path section
Line 64 still refers to "a transaction webhook" — the old generic stream language. After this PR the canonical name is
CARD_TRANSACTION.EXCEPTION. Leaving the old terminology here is inconsistent with the updated Status transitions section directly above it.Context Used: mintlify/AGENTS.md (source)
Prompt To Fix With AI
This is a comment left during a code review. Path: mintlify/snippets/cards/reconciliation.mdx Line: 64-67 Comment: **Stale "transaction webhook" phrasing in the EXCEPTION path section** Line 64 still refers to "a transaction webhook" — the old generic stream language. After this PR the canonical name is `CARD_TRANSACTION.EXCEPTION`. Leaving the old terminology here is inconsistent with the updated Status transitions section directly above it. **Context Used:** mintlify/AGENTS.md ([source](https://app.greptile.com/lightspark/github/lightsparkdev/grid-api/-/custom-context?memory=51934046-75fb-42d3-9870-f42d61cb60e3)) How can I resolve this? If you propose a fix, please make it concise.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Prompt To Fix All With AI
Fix the following 3 code review issues. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 3
mintlify/snippets/cards/webhooks.mdx:7-9
**Stale intro paragraph contradicts new CARD_TRANSACTION.* section**
Lines 7–9 still say "Card-transaction lifecycle events are not card-specific webhooks — they ride on the generic transaction webhook stream (a follow-up extends the Transaction model with a card destination type)." This sentence now directly contradicts the `CARD_TRANSACTION.*` section added later in the same file. A reader scrolling top-to-bottom will be told these events are *not* card webhooks, then immediately see a card webhook table for them.
This paragraph was the placeholder for the follow-up work; it should be removed now that the follow-up has landed.
### Issue 2 of 3
mintlify/snippets/cards/webhooks.mdx:1
**Outdated "two webhook event types" count in the intro**
The opening sentence says "Cards add *two* webhook event types" but this PR documents five additional `CARD_TRANSACTION.*` events, bringing the total to seven. The count will mislead readers before they reach the event table.
```suggestion
Cards add webhook event types on top of Grid's existing webhook
```
### Issue 3 of 3
mintlify/snippets/cards/reconciliation.mdx:64-67
**Stale "transaction webhook" phrasing in the EXCEPTION path section**
Line 64 still refers to "a transaction webhook" — the old generic stream language. After this PR the canonical name is `CARD_TRANSACTION.EXCEPTION`. Leaving the old terminology here is inconsistent with the updated Status transitions section directly above it.
```suggestion
Signal to watch: a `CARD_TRANSACTION.EXCEPTION` webhook. The payload
includes the full parent record, so your dashboard's exception view is
driven entirely by webhook deliveries — there's no list endpoint to
poll.
```
Reviews (1): Last reviewed commit: "docs: update card webhook documentation ..." | Re-trigger Greptile
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Summary
mintlify/snippets/cards/webhooks.mdxto document the five newCARD_TRANSACTION.*event types (AUTHORIZED, PARTIALLY_SETTLED, SETTLED, REFUNDED, EXCEPTION)mintlify/snippets/cards/reconciliation.mdxto referenceCARD_TRANSACTION.*webhooks instead of "generic transaction webhook stream"CARD.*andCARD_TRANSACTION.*to the retry policy table inmintlify/snippets/webhooks.mdxCardTransaction.yamlschema description to reference the new webhooksThese changes sync documentation with the CARD_TRANSACTION webhook contract added in cd9cb0c.
Test plan
make lintto verify OpenAPI changesmake mintand verify card webhook documentation renders correctly🤖 Generated with Claude Code