Notification Center¶

Notification Center configuration and usage guide.

Overview¶

The Notification Center delivers timely, customizable alerts about vulnerability management activity across your Faraday instance. Notifications are configured per-user and support three delivery channels: In-App, Email, and Slack.

Key Characteristics¶

Notification Categories¶

Each category controls notifications for a specific area of Faraday. Categories are enabled or disabled independently, and each supports three channel toggles.

Note: The available categories depend on your license and user role. Corporate License administrators have access to all categories by default.

Notification Settings¶

Access notification settings from the Notifications section in the left panel.

Configuring Categories¶

1. Navigate to the Notifications > Settings section in the left panel.
2. Each category row has a toggle switch and three channel columns.
3. Toggle switch (left): Enable or disable the entire category. Disabling halts all notifications for that category.
4. IN-APP column: Notifications appear in the bell icon dropdown.
5. EMAIL column: Notifications are sent to the email address linked to your user account.
6. SLACK column: Notifications are sent to your configured Slack workspace (see Configure Slack Notifications).

Global Settings¶

Delivery Channels¶

In-App Notifications¶

In-app notifications appear in the Notification Bell at the top right of the Faraday interface.

• Clicking the bell shows the last 4 notifications in a dropdown.
• A red badge shows the count of unread notifications.
• Clicking a notification navigates to the source (e.g., the updated vulnerability or assigned planner task).

Email Notifications¶

Email notifications are sent to the email address configured in your user account.

Prerequisites:

• SMTP must be configured by an administrator (see SMTP Configuration below).
• The EMAIL column must be enabled for the desired category.

Slack Notifications¶

Slack notifications are sent as direct messages to the user's Slack account.

Prerequisites:

• A Faraday administrator must configure the Slack integration (see Configure Slack Notifications).
• The user must have their Slack member ID configured in Faraday Preferences.
• The SLACK column must be enabled for the desired category.

SMTP Configuration¶

Email notifications require a working SMTP configuration. SMTP settings are stored in the database and managed via the API or faraday-manage.

For cloud users, no SMTP configuration is needed.

Configuring SMTP via CLI¶

faraday-manage settings -a update smtp

You will be prompted to enter values for each field. When enabled is true, username, password, and host are required.

Configuring SMTP via API¶

PUT /_api/v3/settings/smtp
Content-Type: application/json

{
  "enabled": true,
  "host": "smtp.example.com",
  "port": 587,
  "username": "notifications@example.com",
  "password": "your-smtp-password",
  "sender": "faraday@example.com",
  "ssl": true
}

Common SMTP Configurations¶

Gmail / Google Workspace:

Microsoft 365:

Self-hosted (no auth):

Notifications Log¶

All notifications from enabled categories are recorded in the Notifications Log, accessible from the Notifications section.

Log Features¶

Workspace Scoping¶

Notifications are workspace-scoped. Users only receive notifications for workspaces they have access to, regardless of their category settings.

• Planner notifications are an exception: they inform users about tasks assigned to them (or tasks they were previously assigned to), regardless of workspace membership.

Troubleshooting¶

No Notifications Appearing¶

Email Notifications Not Sending¶

Slack Notifications Not Arriving¶

Advanced Notifications¶

To access the advanced notifications, navigate to the 'Advanced' tab. For more information, refer to the Advanced Notifications Configuration documentation.