Document Idempotency Behaviour for 429 Rate-Limited Responses - #1842
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Codat-Sean
marked this pull request as ready for review
June 3, 2026 16:47
|
Link check results for preview deployment (https://codat-docs-git-Idempotency-Doc-Updates-codat.vercel.app): |
pmckinney-codat
approved these changes
Jun 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a new "Rate-limited requests and idempotency" section to the Idempotency page
(
docs/using-the-api/write-data/idempotency.md).It documents that Codat does not cache
429 Too Many Requestsresponses against anIdempotency-Key. Because arate-limited request is never processed, the response is not stored and the key is released, so clients can safely
retry with the same
Idempotency-Keyonce the limit clears - the retry is forwarded as a fresh attempt ratherthan replaying the earlier
429from the cache. This applies to both Codat's own rate limits and those of theunderlying financial platform.
The section also adds guidance to honour the
Retry-Afterheader and reuse the original key (so the eventualsuccessful write stays protected against duplication), and clarifies that this behaviour is specific to
429- other4xxand5xxresponses continue to be cached and replayed as before. Cross-links to the existing Rate limits page.Prettier and cspell checks pass. No images added.
Type of change