Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Notifications

The Wazuh Indexer Notifications plugin is a specialized component designed to extend the Wazuh Indexer (based on OpenSearch) with multi-channel notification capabilities. It allows the system to send alerts, reports, and messages via Email (SMTP/SES), Slack, Microsoft Teams, Amazon Chime, Amazon SNS, and Custom Webhooks.

Key Capabilities

  • Multi-channel delivery: Send notifications to Slack, Microsoft Teams, Chime, Email (SMTP and AWS SES), AWS SNS, and custom HTTP webhooks.
  • Unified REST API: Create, update, delete, and query notification channel configurations through a single API surface at /_plugins/_notifications/.
  • Test notifications: Validate channel configuration by sending a test message before relying on it for production alerts.
  • Feature discovery: Other plugins can query supported notification features dynamically.
  • RBAC integration: Access to notification configurations is governed by the Wazuh Indexer Security plugin, with backend-role–based filtering.
  • Extensible architecture: The plugin uses a Service Provider Interface (SPI) pattern, making it straightforward to add new destination types.

Supported Channel Types

Channel TypeProtocolDescription
slackHTTPS (Webhook)Posts messages to a Slack channel via an Incoming Webhook URL.
chimeHTTPS (Webhook)Posts messages to an Amazon Chime room via a webhook URL.
microsoft_teamsHTTPS (Webhook)Posts messages to a Microsoft Teams channel via a connector webhook.
webhookHTTP/HTTPSSends a payload to an arbitrary HTTP endpoint with configurable method, headers, and URL.
emailSMTP / AWS SESSends email messages. Requires an smtp_account or ses_account configuration.
snsAWS SNS SDKPublishes a message to an Amazon SNS topic.
smtp_accountDefines SMTP server connection details (host, port, method, credentials).
ses_accountDefines AWS SES sending details (region, role ARN, from address).
email_groupDefines a group of email recipients for reuse across email-type channels.

Dependencies

This plugin has a dependency on the wazuh-indexer-common-utils repository. It uses the Common Utils jar to provide shared utility functions and common components required for plugin functionality.

Version

The current plugin version is 5.0.0-alpha0 (see VERSION.json in the repository root).