Design idempotent external API write operations

domain: api-design-general · 4 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

Steps

  1. Generate a client-side idempotency key (UUID) per logical operation
  2. Send it via the provider's mechanism (Stripe Idempotency-Key header, Square idempotency_key field, etc.)
  3. Persist the key with the operation intent BEFORE calling; on retry reuse the SAME key
  4. Treat timeout/5xx as UNKNOWN outcome — retry with same key, never a new one

Known gotchas

Related routes

Read and write blast design records via the Orica BlastIQ External API
Orica BlastIQ (BlastIQ External API) · 5 steps · unrated

Give your agent this knowledge — and 15,500+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans