Appearance
Core Concepts
How it works
CheckMK
Wazuh
Zabbix
Custom Script / API
POST /api/notify
Routing Rules Engine
Panel
Email
Telegram
Matrix
Webhook
All messages are stored in History regardless of routing
Messages
A message has:
| Field | Description |
|---|---|
title | Short summary (required) |
message | Full body text (required) |
level | success, warning, error, critical, info (default: info) or custom level |
ttl | How long a panel displays it, in milliseconds (optional) |
Endpoints
An endpoint is a delivery destination. Notifiq supports:
| Type | Description |
|---|---|
| Panel | Real-time display: Android app, Linux app, Docker browser panel |
| SMTP delivery | |
| Matrix | Matrix room message |
| Telegram | Telegram bot message |
| Webhook | HTTP POST to any URL |
Endpoints are registered in Settings → Endpoints and can be grouped for bulk routing.
Routing Rules
Rules control which messages get delivered to which endpoints.
A rule defines:
- Conditions — filter by level, keyword, or IP
- Targets — which endpoints or groups receive matching messages
Messages that match no rule are still stored in History but not delivered anywhere.
See Rules for details.
Message Levels
Defaults are:
| Level | Color | Typical use |
|---|---|---|
success | Green | Recovery, OK state |
info | Blue | Informational events |
warning | Yellow | Soft alerts |
error | Orange | Non-critical failures |
critical | Red | Immediate action required |
You can add custom levels in Settings → Notifications
Panels
Panels receive messages in real time over a persistent SSE connection. A panel:
- Authenticates with a bearer token
- Registers itself (name, type) on connection
- Receives a heartbeat to track online status
User Roles
| Role | Can do |
|---|---|
| Super Admin | Manage all tenants |
| Admin | Full access within their tenant |
| Operator | Send notifications, manage endpoints |
| Viewer | Read-only access to history |