Pular para o conteúdo principal
POST
Process exception callback

Autorizações

X-Callback-Token
string
header
obrigatório

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

Cabeçalhos

X-Callback-Token
string
obrigatório

Opaque bearer token authenticating the external system

X-Idempotency
string
obrigatório

Idempotency key for deduplication

Parâmetros de caminho

exceptionId
string<uuid>
obrigatório

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

Exemplo:

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

Corpo

application/json

Callback payload from external system

assignee
string
obrigatório

Assignee identifier (required when status is ASSIGNED)

Exemplo:

"user@example.com"

callbackType
string
obrigatório

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

Exemplo:

"status_update"

dueAt
string | null
obrigatório

Due date for resolution as an RFC 3339 timestamp

Exemplo:

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

externalIssueId
string
obrigatório

Issue ID in the external system

Minimum string length: 1
Exemplo:

"RECON-1234"

externalSystem
string
obrigatório

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

Minimum string length: 1
Exemplo:

"JIRA"

payload
object
obrigatório

Arbitrary payload from the external system

resolutionNotes
string
obrigatório

Optional resolution notes

Exemplo:

"Resolved by external agent"

status
string
obrigatório

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

Minimum string length: 1
Exemplo:

"RESOLVED"

updatedAt
string | null
obrigatório

External system timestamp as an RFC 3339 timestamp

Exemplo:

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

Resposta

Callback processed successfully.

status
string
obrigatório

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

Exemplo:

"accepted"