The Debbie API supports idempotency for non-idempotent requests through the optional Idempotency-Key header. This ensures that retrying the same request multiple times will produce the same result, preventing duplicate operations.
Using Idempotency Keys
- Include an Idempotency-Key header with a unique string (we recommend UUIDs)
- Maximum key length is 64 characters
- Keys are valid for 48 hours
- Responses served from the idempotency cache include an Idempotency-Cached header
Example
Error Cases
- Invalid key format: 400 Bad Request
- Reusing a key for a different request: 400 Bad Request
Best practices
- Use a new key for each unique business transaction
- Use the same key when retrying a failed request
- Store keys with request details for debugging
When adding case vouchers you can also use the uniqueId field on each case
voucher to prevent the same voucher from being created twice.
