For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notifications

Notification settings allow you to control how OX communicates operational and security-related events to your organization.

OX supports the following types of notifications:

  • Personal notifications, which each user manages individually

  • Organization notifications, which administrators manage for the entire organization

You can use notifications to monitor scan failures, expired credentials, expiring exclusions, and organization activity summaries.

The main parts of the Notification Settings page are:

  • My Notifications: Personal notifications managed by each user

  • System Notifications: Organization-level notifications managed by administrators

My Notifications

The My Notifications section contains personal notifications that each user can manage independently.

You can enable Weekly Digest to receive by email a weekly summary of activity in your organization.

This notification is available to all users, including non-admin users.

System Notifications

The System Notifications section allows administrators to configure organization-wide notifications for operational and security events.

Administrators can:

  • Enable or disable notifications

  • Configure email notifications

  • Configure Slack notifications

  • Select notification recipients

Notification recipients

For each notification type, administrators can configure recipients separately for email and slack notifications.

Recipient selectors support:

  • Individual users

  • User groups

  • Administrative groups

Recipients are managed centrally by administrators. Users cannot remove themselves from administrator-configured notifications.

Notification use cases

  • Regular Scan Failures: Get notified when a regular scan fails to complete.

  • Pipeline Scan Failures: Get notified when a pipeline scan fails to complete.

  • Expired token: Get notified when an authentication token has expired.

  • Expired OX API keys: Get notified when an API key has expired.

  • Exclusion expiring: Get notified before an exclusion expires.

Notification configuration reference

Notification
What to use

Regular Scan Failures

Enable the notification and configure By Email and/or By Slack recipients for failed regular scans

Pipeline Scan Failures

Enable the notification and configure By Email and/or By Slack recipients for failed pipeline scans

Expired token

Enable the notification and configure By Email and/or By Slack recipients for expired authentication tokens

Expired OX API keys

Enable the notification, select By Email to notify the API key creator, and optionally configure By Slack recipients

Exclusion expiring

Enable the notification and configure By Email and/or By Slack recipients for exclusions that are about to expire

Slack notifications

To configure Slack notifications:

  1. Enable the required notification.

  2. Select By Slack.

  3. Configure the Slack recipients.

Exclusion expiration reminders

When an exclusion is about to expire, OX sends reminder notifications automatically:

  1. One week before the exclusion expiration date

  2. One day before the exclusion expiration date

These reminders help ensure that temporary exclusions are reviewed before they expire.

User permissions

User type
What to use

Administrator

Configure organization notifications, delivery methods, and recipients

Non-admin user

Manage only the Weekly Digest notification

Audit logs

Changes made to notification settings are recorded in the audit logs.

Last updated