Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Exception

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

Path parameters

exceptionIdstring required

The unique identifier of the exception.

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

callbackTypestring

Type of callback event

externalSystemstring required

Name of the external system sending the callback

externalIssueIdstring required

Issue identifier in the external system

statusstring required

Current status in the external system

resolutionNotesstring

Notes from the external system resolution

assigneestring

Current assignee in the external system

dueAtstring date-time

Due date from the external system

updatedAtstring date-time

Last update timestamp from the external system

payloadobject

Additional callback data from the external system

Example request

{
  "callbackType": "status_update",
  "externalSystem": "JIRA",
  "externalIssueId": "RECON-1234",
  "status": "RESOLVED"
}

Response

Callback processed successfully.

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.

statusstring

Callback processing status

Example response

{
  "status": "accepted"
}