Skip to main content
POST
Record the human treatment of a parked STA event

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

eventId
string
obrigatório

Lerian STA's event id, exactly as it appears on the parked message. It is a string on Lerian STA's side and is not required to be a UUID.

Exemplo:

"evt-7f3c9a10"

Corpo

application/json
action
enum<string>
obrigatório

What you did: replayed (cause fixed, message shovelled back — the consumer is idempotent), recorded (the disposition stands; the commonest case is parse_rejected, where the remittance row is already REJECTED), escalated (the order could not be reproduced inside the window and the institution is talking to the court).

Opções disponíveis:
replayed,
recorded,
escalated
Exemplo:

"replayed"

institutionId
string
obrigatório

The institution on whose behalf the dead-letter queue was drained. This is NOT necessarily the institution the message resolved to: institution_unresolved is itself one of the parking reasons, and a message parked under it resolved to nobody. In multi-tenant mode it is the tenant whose vhost the queue lives in.

Exemplo:

"44444444-4444-4444-4444-444444444444"

queue
enum<string>
obrigatório

Which of the two queues the message was parked from. These are the values the metric's queue label carries — the direction, not the configured queue name, so the record can be read next to the series.

Opções disponíveis:
inbound,
outbound
Exemplo:

"outbound"

reason
enum<string>
obrigatório

The parking token, read from the message's x-sisbajud-reason header. The values are the consumer's closed set; "other" is deliberately absent, being the fallback the code produces for a token nobody declared.

Opções disponíveis:
direction_mismatch,
doctype_header_mismatch,
doctype_not_allowed,
doctype_pair_mismatch,
doctype_unexpected_shape,
doctype_unmapped,
event_duplicate,
handler_not_wired,
handler_panic,
institution_unresolved,
lock_held,
object_key_out_of_scope,
object_missing,
parse_rejected,
payload_shape_invalid,
payload_too_large,
receive_transient,
sha256_mismatch,
sta_state_unknown,
tenant_scope_mismatch,
tenant_set_unavailable,
terminal_conflict,
transfer_not_found,
transition_out_of_order
Exemplo:

"institution_unresolved"

note
string

Why, in your own words. MUST NOT contain personal data (CPF/CNPJ, names, process numbers) or monetary values: it is written verbatim into a permanent, append-only audit record. Text carrying a run of more than 10 digits is refused with 422 — that is a floor against pasting an identifier, not a check that recognises a name.

Exemplo:

"institution config was missing the STA credential; added and replayed"

Resposta

OK

receiptId
string
obrigatório

The audit record's id. It identifies THIS acknowledgement, not the message: Lerian STA's event id is a string and is recorded as the audit correlation id.

Exemplo:

"cccccccc-cccc-cccc-cccc-cccccccccccc"