Pular para o conteúdo principal
GET
Obter a saúde de entrega da assinatura

Autorizações

Authorization
string
header
obrigatório

Um JWT bearer emitido pelo plugin-auth (lib-auth). A identidade do tenant é resolvida a partir das claims validadas do token; a superfície /v1 nunca lê um tenant do corpo, do path ou da query. Chamadores de máquina obtêm um token via o fluxo client-credentials do plugin-auth. A superfície /admin autoriza contra um escopo de operador e não carrega contexto de tenant.

Parâmetros de caminho

id
string<uuid>
obrigatório

The unique identifier of the subscription (UUIDv7).

Resposta

O rollup de saúde de entrega.

The consolidated, non-secret delivery-health rollup for one subscription.

subscription_id
string<uuid>
obrigatório

The subscription the rollup describes.

Exemplo:

"0192f1a0-0000-7000-8000-00000000a001"

enabled
boolean
obrigatório

The operator on/off flag.

Exemplo:

true

verification_state
enum<string>
obrigatório

The subscription's position in the destination verification state machine. Only an active subscription is deliverable. A webhook sub is born active; a queue sub is born pending_verification and reaches active on a successful credential probe. degraded and disabled signal an impaired or auto-disabled destination that a successful verify returns to active.

Opções disponíveis:
pending_verification,
active,
degraded,
disabled
status
enum<string>
obrigatório

The rolled-up delivery-health verdict. Down means the subscription was auto-disabled by the system (the endpoint is judged broken); Degraded means a lesser impairment (a manual disable, dead-lettered attempts, or dropped tenant events); Healthy otherwise.

Opções disponíveis:
Healthy,
Degraded,
Down
delivery_outcomes
object
obrigatório

Delivery-attempt outcome counts over the configured recent window (keyed by outcome, e.g. delivered, failed, dead_lettered). Always an object, never null.

Exemplo:
recent_outcomes
object
obrigatório

The same outcome histogram restricted to the last 24 hours (a subset of delivery_outcomes). Always an object; an outcome with no recent activity is simply a missing key.

Exemplo:
success_rate
number | null
obrigatório

The derived per-attempt delivery rate over the window (delivered / (delivered + failed + dead_lettered)), in [0.0, 1.0]. null when there are zero terminal attempts (distinct from a genuine 0.0). Per-attempt, not per-job, and informational only — it does not change status.

Exemplo:

0.7

dead_lettered
integer
obrigatório

The count of dead-lettered attempts in the window.

Exemplo:

1

poison_events
integer
obrigatório

A best-effort count of quarantined (poison) events keyed on the untrusted captured tenant id; drives dropped_tenant.

Exemplo:

3

dropped_tenant
boolean
obrigatório

True when quarantined tenant events were observed.

Exemplo:

true

consumer_lag_ms
integer<int64>
obrigatório

Process consumer lag in milliseconds; 0 when no lag-as-time source is exposed.

Exemplo:

12000

auto_disabled
boolean | null
obrigatório

The auto-disable verdict: null when the subscription has no recorded attempts yet, false when a health row exists with no verdict, true when auto-disable has tripped (which drives status: "Down").

Exemplo:

true

disabled_reason
string

A fixed, secret-free auto-disable verdict token (e.g. consecutive_failures). Omitted when empty.

Exemplo:

"consecutive_failures"

last_success_at
string<date-time>

The last successful delivery timestamp (RFC 3339). Omitted when none.

Exemplo:

"2026-06-01T12:00:00Z"

last_failure_at
string<date-time>

The last failed delivery timestamp (RFC 3339). Omitted when none.

Exemplo:

"2026-06-05T09:30:00Z"