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

Dispatch exception to external system

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/dispatch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetSystem": "JIRA",
  "queue": "RECON-TEAM"
}
'

200

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

Authorizations

Authorization · string · header · required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id · string

A unique identifier for tracing the request across services.

X-Idempotency-Key · string

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.

Path Parameters

exceptionId · string · required

Exception ID

Body

application/json

Dispatch payload

Dispatch request payload

targetSystem · enum<string> · required

Target system to dispatch to

Available options: JIRA, SERVICENOW, WEBHOOK, MANUAL

Maximum string length: 255

Example:

"JIRA"

queue · string

Optional queue or team assignment

Maximum string length: 255

Example:

"RECON-TEAM"

Response

200

application/json

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.

Dispatch result

acknowledged · boolean

Whether the dispatch was acknowledged

Example:

true

dispatchedAt · string

When the dispatch occurred in RFC3339 format

Example:

"2025-01-15T10:30:00.000Z"

exceptionId · string

Exception ID that was dispatched

Example:

"019c96a0-10d2-7134-ba5f-664142ee7052"

externalReference · string

External reference ID from target system

Example:

"RECON-1234"

target · string

Target system dispatched to

Example:

"JIRA"