Skip to main content
POST
Dispatch exception to external system

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
string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409, and an idempotency storage failure returns 500. These refusals are problem documents.

Path Parameters

exceptionId
string<uuid>
required

Exception ID Exception ID (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Dispatch payload

targetSystem
enum<string>
required

Target system to dispatch to

Available options:
JIRA,
SERVICENOW,
WEBHOOK,
MANUAL
Required string length: 1 - 255
Example:

"MANUAL"

queue
string

Optional queue or team assignment

Maximum string length: 255
Example:

"RECON-TEAM"

Response

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

acknowledged
boolean
required

Whether the target system acknowledged the dispatch

Example:

true

dispatchedAt
string
required

Dispatch timestamp as an RFC 3339 timestamp

Example:

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

exceptionId
string
required

Identifier of the exception that was dispatched (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

target
string
required

External target system the exception was dispatched to

Example:

"JIRA"

externalReference
string

Reference identifier returned by the target system

Example:

"RECON-1234"