Skip to main content
Version: 1.4 (Current)

Overview

ToBeAlert’s notification system is configured from the web interface under Management. It is split into four parts that you should create in a logical order:

StepWhat you configureMenu / routeDocumentation
1Methods — channel (email, Telegram, …)Management → Notification methods → /notifications-methodsNotification methods
2Groups — who receivesNotifications → Groups → /notifications/groupsNotification groups
3Templates — HTML message body (%severity%, %attributes.key%, …)Notifications → Templates → /notifications/templatesNotification templates
4Rules — when and how to sendNotifications → Rules → /notifications/rulesNotification rules

Rules link a method, optionally groups or users in the action, and a template (in email/Telegram action settings). Under Rules, nested tabs also expose All executions — past rule runs (matched / sent / errors), separate from per-alert Notification sent rows in Alert history.

Notifications hub — Rules tab and Create rules

Where to find it in the UI​

In the sidebar under Management:

  • Notification methods — channel setup (SMTP, Telegram bot, etc.).
  • Notifications — three top-level tabs with item counts: Rules, Templates, Groups

On Rules, nested tabs:

Nested tabRoutePurpose
Notification rules/notifications/rulesCreate and manage rules (segmented All / Basic / Recurring)
All executions/notifications/rules/historyGlobal rule-run history (timeline, TQL, date range)

Common buttons on list views: Refresh and Create (the label includes the active tab, e.g. Create rules). On All executions, only Refresh (no Create, no All/Basic/Recurring). Details: Notification rules — All executions.

Permissions

Configuring notification methods and managing rules, templates, and groups each require the appropriate permissions in your organization (read:notifications, write:notifications, write:notification_methods, admin:notifications). read:notifications opens the list, the per-rule history drawer, and All executions. Deleting execution rows needs admin:notifications. If menus or Create buttons are missing, contact your administrator. See Permissions reference — Notifications.

How the four parts fit together​

Typical email example:

  1. Method smtp-prod: host smtp.company.com, port 587, credentials.
  2. Group on-call-n1: on-call team users.
  3. Template critical-alert: HTML with severity, service, and link.
  4. Rule critical-production:
    • Conditions: severity = critical, environment = Production, 24h schedule.
    • Trigger: Post receive.
    • Actions: method smtp-prod, recipients = group on-call-n1, HTML = template critical-alert.

ToBeAlert evaluates rules by priority, applies your conditions and schedule, then sends notifications through the configured method.

License limits​

The UI may disable Create when your license limit is reached:

ResourceWhen limited
RulesCreate rules is unavailable
TemplatesCreate templates is unavailable
GroupsCreate groups is unavailable
ModuleRelationship
Workflows (Notify node)Can reference notification groups in flow parameters
Webhook ConfigurationsInbound webhooks (receive alerts); not the same as outbound REST notification methods
Users, roles and permissionsUsers assignable to groups; see Managing users for account setup

Best practices​

  1. Deploy in order: methods → groups → templates → rules.
  2. One method per environment/channel and reuse across rules.
  3. Clear priorities: more specific rules with a lower priority number than generic ones.
  4. Test methods before enabling critical rules.
  5. Use templates for HTML; avoid duplicating markup on every rule.
  6. Groups by team/role, not ad-hoc user lists per rule.
  7. Watch for “Pending” status — often a misconfigured time window.
  8. Review All executions after enabling or changing rules — matched vs sent counts and errors surface send problems before operators notice missing mail.
  9. Do not confuse API webhooks with UI notification methods.