mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2026-03-28 20:33:33 -04:00
111 lines
4.2 KiB
Markdown
111 lines
4.2 KiB
Markdown
# Notification Text Templates
|
|
|
|
> Customize how devices and events appear in **text** notifications (email previews, push notifications, Apprise messages).
|
|
|
|
By default, NetAlertX formats each device as a vertical list of `Header: Value` pairs. Text templates let you define a **single-line format per device** using `{FieldName}` placeholders — ideal for mobile notification previews and high-volume alerts.
|
|
|
|
HTML email tables are **not affected** by these templates.
|
|
|
|
## Quick Start
|
|
|
|
1. Go to **Settings → Notification Processing**.
|
|
2. Set a template string for the section you want to customize, e.g.:
|
|
- **Text Template: New Devices** → `{Device name} ({MAC}) - {IP}`
|
|
3. Save. The next notification will use your format.
|
|
|
|
**Before (default):**
|
|
```
|
|
🆕 New devices
|
|
---------
|
|
MAC: aa:bb:cc:dd:ee:ff
|
|
Datetime: 2025-01-15 10:30:00
|
|
IP: 192.168.1.42
|
|
Event Type: New Device
|
|
Device name: MyPhone
|
|
Comments:
|
|
```
|
|
|
|
**After (with template `{Device name} ({MAC}) - {IP}`):**
|
|
```
|
|
🆕 New devices
|
|
---------
|
|
MyPhone (aa:bb:cc:dd:ee:ff) - 192.168.1.42
|
|
```
|
|
|
|
## Settings Reference
|
|
|
|
| Setting | Type | Default | Description |
|
|
|---------|------|---------|-------------|
|
|
| `NTFPRCS_TEXT_SECTION_HEADERS` | Boolean | `true` | Show/hide section titles (e.g. `🆕 New devices \n---------`). |
|
|
| `NTFPRCS_TEXT_TEMPLATE_new_devices` | String | *(empty)* | Template for new device rows. |
|
|
| `NTFPRCS_TEXT_TEMPLATE_down_devices` | String | *(empty)* | Template for down device rows. |
|
|
| `NTFPRCS_TEXT_TEMPLATE_down_reconnected` | String | *(empty)* | Template for reconnected device rows. |
|
|
| `NTFPRCS_TEXT_TEMPLATE_events` | String | *(empty)* | Template for event rows. |
|
|
| `NTFPRCS_TEXT_TEMPLATE_plugins` | String | *(empty)* | Template for plugin event rows. |
|
|
|
|
When a template is **empty**, the section uses the original vertical `Header: Value` format (full backward compatibility).
|
|
|
|
## Template Syntax
|
|
|
|
Use `{FieldName}` to insert a value from the notification data. Field names are **case-sensitive** and must match the column names exactly.
|
|
|
|
```
|
|
{Device name} ({MAC}) connected at {Datetime}
|
|
```
|
|
|
|
- No loops, conditionals, or nesting — just simple string replacement.
|
|
- If a `{FieldName}` does not exist in the data, it is left as-is in the output (safe failure). For example, `{NonExistent}` renders literally as `{NonExistent}`.
|
|
|
|
## Variable Availability by Section
|
|
|
|
Each section has different available fields because they come from different database queries.
|
|
|
|
### `new_devices` and `events`
|
|
|
|
| Variable | Description |
|
|
|----------|-------------|
|
|
| `{MAC}` | Device MAC address |
|
|
| `{Datetime}` | Event timestamp |
|
|
| `{IP}` | Device IP address |
|
|
| `{Event Type}` | Type of event (e.g. `New Device`, `Connected`) |
|
|
| `{Device name}` | Device display name |
|
|
| `{Comments}` | Device comments |
|
|
|
|
**Example:** `{Device name} ({MAC}) - {IP} [{Event Type}]`
|
|
|
|
### `down_devices` and `down_reconnected`
|
|
|
|
| Variable | Description |
|
|
|----------|-------------|
|
|
| `{devName}` | Device display name |
|
|
| `{eve_MAC}` | Device MAC address |
|
|
| `{devVendor}` | Device vendor/manufacturer |
|
|
| `{eve_IP}` | Device IP address |
|
|
| `{eve_DateTime}` | Event timestamp |
|
|
| `{eve_EventType}` | Type of event |
|
|
|
|
**Example:** `{devName} ({eve_MAC}) {devVendor} - went down at {eve_DateTime}`
|
|
|
|
### `plugins`
|
|
|
|
| Variable | Description |
|
|
|----------|-------------|
|
|
| `{Plugin}` | Plugin code name |
|
|
| `{Object_PrimaryId}` | Primary identifier of the object |
|
|
| `{Object_SecondaryId}` | Secondary identifier |
|
|
| `{DateTimeChanged}` | Timestamp of change |
|
|
| `{Watched_Value1}` | First watched value |
|
|
| `{Watched_Value2}` | Second watched value |
|
|
| `{Watched_Value3}` | Third watched value |
|
|
| `{Watched_Value4}` | Fourth watched value |
|
|
| `{Status}` | Plugin event status |
|
|
|
|
**Example:** `{Plugin}: {Object_PrimaryId} - {Status}`
|
|
|
|
> [!NOTE]
|
|
> Field names differ between sections because they come from different SQL queries. A template configured for `new_devices` cannot use `{devName}` — that field is only available in `down_devices` and `down_reconnected`.
|
|
|
|
## Section Headers Toggle
|
|
|
|
Set **Text Section Headers** (`NTFPRCS_TEXT_SECTION_HEADERS`) to `false` to remove the section title separators from text notifications. This is useful when you want compact output without the `🆕 New devices \n---------` banners.
|