|
| 1 | +# Panel notifications (iContact messages) |
| 2 | + |
| 3 | +[[TOC]] |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +Imunify can deliver **generic panel notifications** (also referred to as **iContact messages**) through the hosting panel’s native notification mechanism. These notifications are generated by Imunify and delivered by the panel: |
| 8 | + |
| 9 | +- **cPanel/WHM**: delivered via **cPanel iContact** (WHM → *Contact Manager*) |
| 10 | +- **Plesk**: delivered by the **Imunify** Plesk extension via **Plesk Notifications** (*Tools & Settings → Notifications* / Notification Center) |
| 11 | + |
| 12 | +This mechanism is **separate** from Imunify’s event notifications configured in Imunify UI (**Settings → Notifications**) or via `imunify360-agent notifications-config`. See also: [Notifications](/features/#notifications). |
| 13 | + |
| 14 | +## What gets reported |
| 15 | + |
| 16 | +Generic (iContact) notifications are **HTML-capable messages** with a subject and body provided by the Imunify backend. They typically include security alerts and recommendations, for example: |
| 17 | + |
| 18 | +- malware detected / suspicious activity |
| 19 | +- scan not scheduled / scan not running |
| 20 | +- CMS security signals (for example, insecure WordPress core or vulnerable themes/plugins) |
| 21 | + |
| 22 | +Each notification has its own backend-defined cooldown (period limit), and the agent enforces it. |
| 23 | + |
| 24 | +## Who receives these messages |
| 25 | + |
| 26 | +A notification can be addressed either: |
| 27 | + |
| 28 | +- to the **server administrator** (panel admin) — when no specific user is provided, or |
| 29 | +- to a **specific panel user** (customer/reseller) — when a target user login is provided by the backend. |
| 30 | + |
| 31 | +User-targeted delivery is controlled by `CONTROL_PANEL.generic_user_notifications` (default: `True`). |
| 32 | + |
| 33 | +## Licensing |
| 34 | + |
| 35 | +Panel notifications do **not** require an additional add-on license. They are controlled by a configuration option and are available on supported panels where the delivery channel exists (cPanel/WHM, Plesk). |
| 36 | + |
| 37 | +## Requirements |
| 38 | + |
| 39 | +- **Imunify360 or ImunifyAV/AV+** installed and running. |
| 40 | +- **For Plesk delivery**: Plesk installed, and the Imunify extension installed/enabled in Plesk. |
| 41 | +- **For cPanel delivery**: cPanel/WHM installed, and WHM Contact Manager configured with at least one destination. |
| 42 | + |
| 43 | +## Configuration (Imunify) |
| 44 | + |
| 45 | +The feature is controlled by Imunify configuration keys: |
| 46 | + |
| 47 | +- **Config path**: `/etc/sysconfig/imunify360/imunify360.config` (or a file in `/etc/sysconfig/imunify360/imunify360.config.d/`) |
| 48 | +- **Keys**: |
| 49 | + - `ADMIN_CONTACTS.enable_icontact_notifications` (**default:** `True`) |
| 50 | + - `CONTROL_PANEL.generic_user_notifications` (**default:** `True`, controls user-targeted delivery) |
| 51 | + |
| 52 | +### Enable/disable in YAML |
| 53 | + |
| 54 | +```yaml |
| 55 | +ADMIN_CONTACTS: |
| 56 | + enable_icontact_notifications: True |
| 57 | +``` |
| 58 | +
|
| 59 | +### Enable/disable via CLI |
| 60 | +
|
| 61 | +**Imunify360:** |
| 62 | +
|
| 63 | +```bash |
| 64 | +imunify360-agent config update '{"ADMIN_CONTACTS": {"enable_icontact_notifications": true}}' |
| 65 | +``` |
| 66 | +
|
| 67 | +Disable: |
| 68 | +
|
| 69 | +```bash |
| 70 | +imunify360-agent config update '{"ADMIN_CONTACTS": {"enable_icontact_notifications": false}}' |
| 71 | +``` |
| 72 | +
|
| 73 | +**ImunifyAV/AV+:** |
| 74 | +
|
| 75 | +```bash |
| 76 | +imunify-antivirus config update '{"ADMIN_CONTACTS": {"enable_icontact_notifications": true}}' |
| 77 | +``` |
| 78 | +
|
| 79 | +### (Optional) Disable user-targeted delivery |
| 80 | +
|
| 81 | +If you want these notifications to go **only to the server administrator** and never to end users, disable `CONTROL_PANEL.generic_user_notifications`. |
| 82 | + |
| 83 | +**Imunify360 (global):** |
| 84 | + |
| 85 | +```bash |
| 86 | +imunify360-agent config update '{"CONTROL_PANEL": {"generic_user_notifications": false}}' |
| 87 | +``` |
| 88 | + |
| 89 | +**Imunify360 (for a specific user):** |
| 90 | + |
| 91 | +```bash |
| 92 | +imunify360-agent config update '{"CONTROL_PANEL": {"generic_user_notifications": false}}' --user <username> |
| 93 | +``` |
| 94 | + |
| 95 | +**ImunifyAV/AV+:** |
| 96 | + |
| 97 | +```bash |
| 98 | +imunify-antivirus config update '{"CONTROL_PANEL": {"generic_user_notifications": false}}' |
| 99 | +``` |
| 100 | + |
| 101 | +## Plesk: managing delivery with Plesk Notifications |
| 102 | + |
| 103 | +When Imunify runs under Plesk, it relies on the **Imunify Plesk extension** to dispatch these messages via Plesk notifications. |
| 104 | + |
| 105 | +- **Where you see it**: in Plesk’s Notification Center, and/or as emails depending on your Plesk notification settings. |
| 106 | +- **Where you configure delivery**: Plesk → **Tools & Settings → Notifications** (choose recipients and optionally add a custom email address). |
| 107 | + |
| 108 | +### Manual test (advanced) |
| 109 | + |
| 110 | +On a server with the Imunify extension installed, run: |
| 111 | + |
| 112 | +```bash |
| 113 | +echo '{"message_type":"Generic","params":{"subject":"Test Generic","body_html":"<p>Hello from Imunify</p>"},"user":"client_login"}' | sudo /opt/imunify360/venv/share/imunify360/scripts/send-notifications |
| 114 | +``` |
| 115 | + |
| 116 | +**Payload fields:** |
| 117 | +- `message_type`: must be `Generic` |
| 118 | +- `params.subject`: notification subject |
| 119 | +- `params.body_html`: HTML body (preferred) |
| 120 | +- `params.body` / `params.text`: plain-text fallback (optional) |
| 121 | +- `user`: Plesk login to receive the message (optional). If omitted, the Admin user is used. |
| 122 | + |
| 123 | +### Plesk CLI (optional) |
| 124 | + |
| 125 | +Plesk email notification settings can also be managed via `plesk bin notification`. See: [How to manage Plesk email notifications via CLI](https://plesk.com/kb/support/how-to-manage-plesk-email-notifications-via-cli/). |
| 126 | + |
| 127 | +::::warning |
| 128 | +We recommend sending security-related Imunify notifications to the **server administrator** (or a dedicated security mailbox) and not to end customers unless you have a clear operational process in place. |
| 129 | +:::: |
| 130 | + |
| 131 | +## cPanel/WHM: delivery via iContact |
| 132 | + |
| 133 | +On cPanel/WHM, Imunify uses cPanel’s iContact system. To manage recipients and channels, use: |
| 134 | + |
| 135 | +- WHM → **Home → Server Contacts → Contact Manager** |
| 136 | + |
| 137 | +Make sure at least one destination (email/SMS/etc.) is configured there. Imunify only controls whether these messages are generated (via `enable_icontact_notifications`); delivery is handled by cPanel. |
| 138 | + |
0 commit comments