PT EN

Caixa de saída

URL base: $BUSINESS_API

Listar eventos da caixa de saída

Registos

GET /outbox/events

Returns one cursor-paginated page (limit, after) of the tenant's outbox records, newest first, ordered by occurrence time. Each record includes its type, aggregate, payload, publish time, retry count and last error. Use it to see which events were delivered and which are stuck. Requires the events:read permission in the tenant.

Parâmetros

limitinteger · consulta · opcional

Maximum resources to return (default 20, maximum 100).

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

statusstring · consulta · opcional

Optional delivery state filter: published (delivered), pending (not yet delivered and never retried) or failed (not delivered after at least one retry); any other value returns 400.

um de pending, published, failed

Devolve

200 Outbox events

Erros 403

Permissões events:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/outbox/events" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

Outbox events

Listar mudanças de estado

Registos

GET /outbox/transitions

Returns one cursor-paginated page (limit, after) of the tenant's status transition log, newest first. Each entry has the from and to status, the actor with a resolved display name where available, the reason and the time. Requires the events:read permission in the tenant.

Parâmetros

limitinteger · consulta · opcional

Maximum resources to return (default 20, maximum 100).

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

aggregate_typestring · consulta · opcional

Optional aggregate type (for example payment or collection_case) to return only transitions of that kind of record; matched exactly.

um de invoice, payment, reading, connection, collection_case, work_order, platform_invoice

aggregate_idstring · consulta · opcional

Optional ID of one record to return only its transitions; combine with aggregate_type to target one record unambiguously.

Devolve

200 Transitions. Each has actor_id, actor_type and actor_name, the actor's display label.

Erros 403

Permissões events:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/outbox/transitions" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

Transitions. Each has actor_id, actor_type and actor_name, the actor's display label.