Skip to content

docs: update card webhook documentation for CARD_TRANSACTION events#693

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/sync-20260716
Open

docs: update card webhook documentation for CARD_TRANSACTION events#693
claude[bot] wants to merge 1 commit into
mainfrom
docs/sync-20260716

Conversation

@claude

@claude claude Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updated mintlify/snippets/cards/webhooks.mdx to document the five new CARD_TRANSACTION.* event types (AUTHORIZED, PARTIALLY_SETTLED, SETTLED, REFUNDED, EXCEPTION)
  • Updated mintlify/snippets/cards/reconciliation.mdx to reference CARD_TRANSACTION.* webhooks instead of "generic transaction webhook stream"
  • Added CARD.* and CARD_TRANSACTION.* to the retry policy table in mintlify/snippets/webhooks.mdx
  • Updated CardTransaction.yaml schema description to reference the new webhooks

These changes sync documentation with the CARD_TRANSACTION webhook contract added in cd9cb0c.

Test plan

  • Run make lint to verify OpenAPI changes
  • Run make mint and verify card webhook documentation renders correctly
  • Verify retry policy table includes the new webhook types

🤖 Generated with Claude Code

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>
@vercel

vercel Bot commented Jul 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Jul 16, 2026 8:53am
grid-wallet-demo Ignored Ignored Jul 16, 2026 8:53am

Request Review

@claude
claude Bot requested review from pengying and shreyav July 16, 2026 08:53
@github-actions

github-actions Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

✱ Stainless preview builds for grid

This PR will update the grid SDKs with the following commit messages.

cli

chore(internal): regenerate SDK with no functional changes

go

docs(types): update CardTransaction documentation

kotlin

docs(api): update CardTransaction webhook documentation

openapi

docs(types): clarify CardTransaction webhook delivery description

php

docs(api): update CardTransaction webhook delivery documentation

python

docs: update CardTransaction webhook descriptions

ruby

docs(types): clarify CardTransaction webhook delivery in model descriptions

typescript

docs: clarify CardTransaction webhook event naming in model descriptions

Edit this comment to update them. They will appear in their respective SDK's changelogs.

grid-typescript studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ❗test ✅

npm install https://pkg.stainless.com/s/grid-typescript/1c70cf671803bad0d00a72e1c2de121ece230f12/dist.tar.gz
grid-openapi studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️

grid-ruby studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ✅test ✅

grid-go studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ❗test ❗

go get github.com/stainless-sdks/grid-go@e322f33c1bde8d50756b8ec85ee59d9f2f149fea
grid-kotlin studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️build ✅lint ✅test ❗

grid-python studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ❗test ❗

pip install https://pkg.stainless.com/s/grid-python/215b64926628ea5e59ded4a6fe409bfeeb7625a9/grid-0.0.1-py3-none-any.whl
grid-php studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅lint ✅test ✅

grid-cli studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️build ❗lint ❗test ❗


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-07-16 08:58:06 UTC

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview Jul 16, 2026, 8:55 AM

@greptile-apps

greptile-apps Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR syncs documentation with the CARD_TRANSACTION.* webhook contract, replacing placeholder text ("a follow-up extends the Transaction model…") with concrete event tables and accurate schema descriptions across the card webhook and reconciliation pages.

  • mintlify/snippets/cards/webhooks.mdx — adds a CARD_TRANSACTION.* section with all five event types and updates the "all three carry" label to "all card webhooks carry", but the old placeholder paragraph (lines 7–9) that explicitly says these events are not card webhooks was not removed, leaving a direct contradiction in the same file.
  • mintlify/snippets/cards/reconciliation.mdx — status-transitions text updated to reference CARD_TRANSACTION.*; the EXCEPTION path description (line 64) still uses the old "transaction webhook" language.
  • mintlify/snippets/webhooks.mdx and both OpenAPI specs — retry-policy rows and schema description updated correctly.

Confidence Score: 3/5

The 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.

Important Files Changed

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
Loading
%%{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
Loading

Comments Outside Diff (3)

  1. mintlify/snippets/cards/webhooks.mdx, line 7-9 (link)

    P1 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.
  2. mintlify/snippets/cards/webhooks.mdx, line 1 (link)

    P2 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!

  3. mintlify/snippets/cards/reconciliation.mdx, line 64-67 (link)

    P2 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

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
Grid 🟡 Building Jul 16, 2026, 8:53 AM

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.

0 participants