Skip to content
ABRQ DATADocs Abrq DIP · latest
Product page Request a trial
On this page

Notification Settings

What this page covers#

Settings → Notifications holds the platform-global notification configuration: one master switch, the SMTP transport, and the license-expiry alert channel. It is admin-only, changes apply at runtime, and secrets are stored encrypted.

Routing — which channels fire for which pipeline events — is configured per resource on the /notifications page, not here. See Notifications and alerts.

The master switch#

Notifications enabled (on by default) is the global kill switch. Turned off, no notification of any kind is dispatched — per-resource channel configs stay saved but dormant.

SMTP transport#

Email channels need an SMTP transport, configured here once for the whole platform:

Field Notes
Host, port Your mail relay (port default 587)
Username, password Password is a write-only secret — set, rotate, or clear; never read back
STARTTLS / implicit TLS STARTTLS on by default
From address The sender identity on outgoing mail
Timeout Send timeout in seconds

After saving, use Send test email (POST /api/v1/notification-settings/test-email) to verify the transport end to end before relying on it for alerts.

License-alert channel#

An optional channel that pages your team as license expiry approaches — off by default. Configure:

  • Kind — one of webhook, email, slack, discord, teams, pagerduty, opsgenie.
  • Target — webhook URL, email address, or routing/API key, depending on the kind. The target is a write-only secret with a masked preview.

Alerts fire in three tiers — warning (30 days or fewer), critical (7 days or fewer), and expired — matching the UI banner tiers (Licensing). Each tier is dispatched at most once per roughly 20 hours (Redis-backed dedup), so an hourly re-check does not re-page you all day.

Use Send test alert (POST /api/v1/notification-settings/test-license-alert) to verify the channel.

The deprecated env-var seed#

Before these settings moved into the database, SMTP and the license-alert channel were environment variables (ABRQ_SMTP_*, ABRQ_LICENSE_ALERT_KIND, ABRQ_LICENSE_ALERT_TARGET). Those variables are now deprecated and behave as a seed only:

  • On first boot, if nothing is configured in the database yet, their values are copied in once (secrets encrypted on the way in).
  • From then on, the database is authoritative — editing the env vars has no further effect.
  • While the deprecated vars remain set, the backend logs notification_env_config_deprecated at startup as a reminder to remove them from the deployment.

Tip. For a fresh install it is fine to pre-seed SMTP via env so email works from the first boot — then manage it in the UI and delete the env vars.