432-api-webhook-discrepancy-documentation

A set of rules for comparing an API or webhook provider's written documentation with the behavior observed in real requests. Webhooks are automated messages sent by one service to another when something happens.

In plain words
What is it for?
Use it before building or debugging an API or webhook integration: capture real events, compare them with the documentation, and record workarounds and version changes.
Why use it?
It helps reveal undocumented payload formats, authentication differences, edge cases, and changes that can break an integration.

Cursor rule

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/hamzaamjad/cursor-rules/432-api-webhook-discrepancy-documentation
Clone the repo
git clone --depth 1 https://github.com/hamzaamjad/cursor-rules
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 1,128 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.01128
Opus 5 $0.00000 $0.00564
Sonnet 5 $0.00000 $0.00226
Haiku 4.5 $0.00000 $0.00113

Measured yesterday against content hash 75b7f94b5433, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

432-api-webhook-discrepancy-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

rules/400-patterns/432-api-webhook-discrepancy-documentation.mdc · 127 lines

How it starts

The opening of the file, as written. The whole thing — 127 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API/Webhook Vendor Documentation Discrepancy Rule

Purpose

To provide a systematic framework for discovering, documenting, and handling discrepancies between vendor-supplied API/webhook documentation and actual implementation behavior. Empirical Impact: Vendor documentation accuracy averages 60-70%, with webhook implementations showing 40% format variations from documented standards.

Requirements

1. Discovery Phase (Before Implementation)

  • Capture Real Data First: Deploy a minimal webhook receiver to capture actual vendor payloads before implementing business logic
  • Document Expected vs Actual: Create comparison tables showing documented vs observed behavior
  • Test Multiple Scenarios: Capture various event types, authentication methods, and edge cases
  • Version Tracking: Document API/webhook versions and any changes over time

2. Systematic Documentation Pattern

## Vendor API/Webhook Discrepancy Report

**Vendor**: [Name]
**API Version**: [Version]
**Documentation URL**: [Link]
**Date Discovered**: [YYYY-MM-DD]

### Authentication Discrepancies
| Documented | Actual | Impact | Workaround |
|------------|--------|--------|------------|
| `sha256=hash` | `t=timestamp,v1=hash` | Signature validation fails | Implemented multi-format verification |

### Header Discrepancies  
| Expected Header | Present | Alternative | Notes |
|----------------|---------|-------------|-------|
| `X-Vendor-Event` | ❌ No | Infer from payload | Event type missing, requires smart detection |

### Payload Format Discrepancies
| Documented Structure | Actual Structure | Parsing Approach |
|---------------------|------------------|------------------|
| `{"event": "type"}` | `{"data": {"event_type": "type"}}` | Nested extraction required |

3. Testing Strategy

  • Multi-Method Authentication: Test all documented auth methods plus common variations
  • Payload Capture: Log complete headers, body, and metadata for analysis
  • Edge Case Discovery: Test with various event types, sizes, and frequencies
  • Environment Validation: Verify consistency across dev/staging/prod endpoints

Read the full file on GitHub · 127 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 127 lines · 0 tokens per session scan A 75b7f94b5433

Subscribe to this mod's changes

432-api-webhook-discrepancy-documentation is a cursor rule published in the GitHub repository hamzaamjad/cursor-rules (2 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,128 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.