How to handle error scenarios when using the Runa API
details
key to identify which fields are invalid.
type
field to determine the type of error that occurred and take appropriate action. You must not rely on the message
or help
fields as these may change over time.
4xx
status codes, indicating an issue with the request being made. For example an invalid payload or a specific error with the payload such as an unsupported value for a product. In these cases you should correct the issue and retry the request using a new idempotency key. Using the same idempotency key will result in the same error being returned.
5xx
status codes, indicating an issue with the Runa API. These errors are usually temporary and can be resolved by retrying the request. In these cases you should retry the request using the same idempotency key. If the error persists you should wait a short period of time before retrying the request.