Process exception callback

Use this endpoint to process a callback from an external system for a dispatched exception. This updates the exception status based on the external system resolution.

POST /v1/exceptions/{exceptionId}/callback

Process exception callback

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/callback \
  --header 'Content-Type: application/json' \
  --header 'X-Callback-Token: <api-key>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "assignee": "[e-mail]",
  "callbackType": "status_update",
  "dueAt": "2025-01-20T10:30:00Z",
  "externalIssueId": "RECON-1234",
  "externalSystem": "JIRA",
  "payload": {},
  "resolutionNotes": "Resolved by external agent",
  "status": "RESOLVED",
  "updatedAt": "2025-01-15T10:30:00Z"
}
'

200

Example

{
  "status": "accepted"
}

Autorizaciones

X-Callback-Token · string · header · requerido

Opaque bearer token authenticating an external system's inbound exception callback.

Encabezados

X-Callback-Token · string · requerido

Opaque bearer token authenticating the external system

X-Idempotency · string · requerido

Idempotency key for deduplication

Parámetros de ruta

exceptionId · string<uuid> · requerido

The unique identifier of the exception. Exception ID (UUID)

Ejemplo:

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

Cuerpo

application/json

Callback payload from external system

assignee · string · requerido

Assignee identifier (required when status is ASSIGNED)

Ejemplo:

"[e-mail]"

callbackType · string · requerido

Type of callback (e.g. status_update, assignment)

Ejemplo:

"status_update"

dueAt · string | null · requerido

Due date for resolution as an RFC 3339 timestamp

Ejemplo:

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

externalIssueId · string · requerido

Issue ID in the external system

Minimum string length: 1

Ejemplo:

"RECON-1234"

externalSystem · string · requerido

External system identifier (e.g. JIRA, SERVICENOW, WEBHOOK)

Minimum string length: 1

Ejemplo:

"JIRA"

payload · object · requerido

Arbitrary payload from the external system

Show child attributes

resolutionNotes · string · requerido

Optional resolution notes

Ejemplo:

"Resolved by external agent"

status · string · requerido

Target status for the exception (e.g. ASSIGNED, RESOLVED)

Minimum string length: 1

Ejemplo:

"RESOLVED"

updatedAt · string | null · requerido

External system timestamp as an RFC 3339 timestamp

Ejemplo:

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

Respuesta

200

application/json

Callback processed successfully.

status · string · requerido

Processing status of the callback (the handler always returns "accepted" on success)

Ejemplo:

"accepted"