Sign in
Admin

Get Notification Status

Return which notification channels are configured (booleans only — no secrets).

Mirrors get_api_key_status: returns presence flags derived from env/settings without ever echoing the SMTP password, webhook URL, or webhook secret without secrets.

get/settings/notifications/status/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Response

Successful Response

notifications_enabledboolean required

Whether the NOTIFICATIONS_ENABLED master toggle is set to true.

smtp_configuredboolean required

Whether an SMTP host is configured (SMTP_HOST is set). Does not echo the host value.

webhook_configuredboolean required

Whether a notification webhook URL is configured (NOTIFICATION_WEBHOOK_URL is set). Does not echo the URL.

Changes

No recorded changes to this operation across all 50 revisions of this API.