Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Exception

Dispatch exception to external system

Use this endpoint to dispatch an exception to an external ticketing system such as JIRA or ServiceNow for tracking and resolution.

post/v1/exceptions/{exceptionId}/dispatch

Path parameters

exceptionIdstring required

Exception ID

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

queuestring

Optional queue or team assignment

targetSystem'JIRA' | 'SERVICENOW' | 'WEBHOOK' | 'MANUAL' required

Target system to dispatch to

Example request

{
  "queue": "RECON-TEAM",
  "targetSystem": "JIRA"
}

Response

Indicates that the request was successful and the response contains the expected data.

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.

acknowledgedboolean

Whether the dispatch was acknowledged

dispatchedAtstring

When the dispatch occurred in RFC3339 format

exceptionIdstring

Exception ID that was dispatched

externalReferencestring

External reference ID from target system

targetstring

Target system dispatched to

Example response

{
  "acknowledged": true,
  "dispatchedAt": "2025-01-15T10:30:00.000Z",
  "exceptionId": "019c96a0-10d2-7134-ba5f-664142ee7052",
  "externalReference": "RECON-1234",
  "target": "JIRA"
}