A network error or a timeout can leave you unsure whether a write request went through. If you send it again, you could create a second feature request or add a second note. An operation key lets you retry safely.
Operation key
Send an operation_key in the JSON body of the request. It is a string that you choose. The first request with a given key runs normally and its response is saved. Any later request with the same key replays the saved response, with the same status code and body, and does not run again.
These APIs accept operation_key:
Example
If you send this request twice, the second response is identical to the first and only one feature request exists.
How keys work
- Keys are scoped to your workspace. Another workspace can use the same key without clashing.
- The key is matched on its own. The saved response is replayed even if the rest of the request is different, so use a new key for each separate action.
- Use a different key for each endpoint call. For example, creating a feature request and then commenting on it need two keys.
- Only requests that succeed are saved. A request that fails with an error does not save its key, so you can fix the request and send it again with the same key.
- If you leave out
operation_key, or send it blank, every request runs and nothing is saved.
- If two requests with the same new key arrive at the same time, one runs and the other replays its response.
Build the key from an identifier you already have, such as a support ticket number and the action. A retry then uses the same key without you storing anything.
