Skip to main content
GET
Get required-notification reporting-plane health
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/health/notifications reports whether the reporting plane for required workflow notifications is working. Point an external uptime monitor at it. It requires the platform:read permission, and the credential’s scopes must reach it.
status is degraded when any of these is true:
  • the sweep is paused;
  • no sweep completed among its ten newest runs;
  • the newest sweep completed more than 180 seconds ago;
  • the oldest pending obligation is more than 300 seconds old.
A growing attentionCount or any unknownCount above zero needs operator triage, but does not change status. The response never includes run, recipient, channel, or message identifiers.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Response

Current required-notification reporting-plane health

data
object
required

Whether required workflow notifications are still being delivered: the obligation sweep's freshness and the obligation queue's age and counts. Content-free.

meta
object
required