MethodPathSummaryAuth
GET/v1/notification-runtime-healthRead notification delivery runtime healthPublic

Contract file:api/control-notifications.openapi.yaml

Operation details

GET /v1/notification-runtime-health

Read notification delivery runtime health

operationId
getNotificationRuntimeHealth
Auth
  • No authentication.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

Outbox worker state with each channel's state, the account flow senders and the last settings rebuild. Reasons and errors are fixed codes and never contain a server address, account name or secret. Also served as the notification member of GET /health/detail. Notification state never makes GET /health/ready fail in the auto mode.

Responses

getNotificationRuntimeHealth Responses
StatusDescription
200Notification runtime health.

Fields:enabled: boolean state: string: disabled / built / running / ready / backoff / stopping / stopped / failed ready: boolean worker_running: boolean enabled_channels: integer consecutive_failures: integer last_error_class?: string mode?: string: explicit / auto / off channels?: object account_senders?: object last_rebuild_at?: string(date-time) last_rebuild_error?: string

↑ Back to list