v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Exception

Bulk dispatch exceptions

Use this endpoint to dispatch multiple exceptions to an external system in a single operation. You can dispatch up to 100 exceptions at a time.

post/v1/exceptions/bulk/dispatch

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

exceptionIdsstring[] required

List of exception IDs to dispatch (maximum 100)

targetSystemstring required

Target external system

queuestring

Target queue within the external system

Example request

{
  "targetSystem": "JIRA"
}

Response

Bulk operation completed (check response for partial failures).

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

succeededstring[]

List of exception IDs that were processed successfully

totalinteger

Total number of exceptions in the request

Example response

{
  "total": 10
}