diff --git a/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-channel.png b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-channel.png new file mode 100644 index 00000000..00fc7151 Binary files /dev/null and b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-channel.png differ diff --git a/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-create-app.png b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-create-app.png new file mode 100644 index 00000000..015abe29 Binary files /dev/null and b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-create-app.png differ diff --git a/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-disconnect.png b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-disconnect.png new file mode 100644 index 00000000..ea8bf409 Binary files /dev/null and b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-disconnect.png differ diff --git a/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-incoming-webhooks.png b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-incoming-webhooks.png new file mode 100644 index 00000000..3b0e70eb Binary files /dev/null and b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-incoming-webhooks.png differ diff --git a/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-name-workspace.png b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-name-workspace.png new file mode 100644 index 00000000..8301fe22 Binary files /dev/null and b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-name-workspace.png differ diff --git a/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-webhook-url-copy.png b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-webhook-url-copy.png new file mode 100644 index 00000000..52b4eb92 Binary files /dev/null and b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-webhook-url-copy.png differ diff --git a/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-webhook-url.png b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-webhook-url.png new file mode 100644 index 00000000..4d8c7eb7 Binary files /dev/null and b/public/docs-static/img/manage/settings/notifications/netbird-notifications-slack-webhook-url.png differ diff --git a/public/docs-static/img/manage/settings/notifications/netbird-settings-notifications-overview.png b/public/docs-static/img/manage/settings/notifications/netbird-settings-notifications-overview.png index 73fa1568..9fca0a2f 100644 Binary files a/public/docs-static/img/manage/settings/notifications/netbird-settings-notifications-overview.png and b/public/docs-static/img/manage/settings/notifications/netbird-settings-notifications-overview.png differ diff --git a/src/pages/manage/settings/notifications.mdx b/src/pages/manage/settings/notifications.mdx index dfeaf41b..f0be81f7 100644 --- a/src/pages/manage/settings/notifications.mdx +++ b/src/pages/manage/settings/notifications.mdx @@ -1,7 +1,7 @@ import {Note} from "@/components/mdx" export const description = - 'Configure email and webhook notifications for important events in your NetBird account.' + 'Configure email, webhook, and Slack notifications for important events in your NetBird account.' # Notifications @@ -12,21 +12,22 @@ NetBird can notify you when important events occur in your account, such as peer

- Notifications overview showing Email and Webhook channels + Notifications overview showing Email, Webhook, and Slack channels

-NetBird supports two notification channels: +NetBird supports three notification channels: | Channel | Description | |---------|-------------| | `Email` | Send notifications to one or more email addresses | | `Webhook` | Send notifications as HTTP POST requests to a custom endpoint | +| `Slack` | Send notifications to a Slack channel via an Incoming Webhook | Each channel can be independently enabled or disabled and configured with its own set of event types. ## Supported Events -Both email and webhook channels support the following notification events: +All notification channels support the following events: | Category | Event | Description | |----------|-------|-------------| @@ -61,7 +62,7 @@ To remove a recipient, click the `x` button next to their email address. ## Webhook Notifications -The webhook channel sends notification events as HTTP `POST` requests to a URL you specify. This is useful for integrating with third-party tools like Slack, Microsoft Teams, PagerDuty, or custom automation systems. +The webhook channel sends notification events as HTTP `POST` requests to a URL you specify. This is useful for integrating with third-party tools like Microsoft Teams, PagerDuty, or custom automation systems. ### Connect a Webhook @@ -97,6 +98,63 @@ To remove the webhook entirely, click `Delete`. Webhook channel page showing Edit and Delete options for a connected webhook

+## Slack Notifications + +The Slack channel lets you receive NetBird notification events directly in a Slack channel via an Incoming Webhook. + +### Connect Slack + +1. Navigate to `Settings` > `Notifications` and click on the `Slack` channel. + +

+ Slack notification channel page with Connect button +

+ +2. Click the `Connect` button to open the Slack configuration modal. In the first step, you will create a Slack App: + - Open [Slack App Management](https://api.slack.com/apps?new_app=1), click `Create an app`, and choose `From scratch`. + +

+ Connect NetBird with Slack - Step 1: Create a Slack App +

+ + - Set the app name to `NetBird Notifications`, select your workspace, and click `Create App`. + +

+ Slack app creation - naming and workspace selection +

+ +3. Click `Continue` to move to the second step. Here you will configure the Incoming Webhook: + - In the Slack app settings, go to `Incoming Webhooks` and toggle `Activate Incoming Webhooks` to `On`. + +

+ Slack Incoming Webhooks settings page +

+ + - Click `Add New Webhook to Workspace`, select the channel where you want to receive notifications,
and confirm with `Allow`. + - Copy the generated `Webhook URL`. + +

+ Copying the Slack webhook URL +

+ + - Paste the Webhook URL into the input field in the NetBird modal. + +

+ Connect NetBird with Slack - Step 2: Enter Webhook URL +

+ +4. Click `Connect` to save the configuration. + +Once connected, you can toggle individual events on or off, just like with the email channel. + +### Disconnect Slack + +To disconnect Slack, click the dropdown menu on the Slack channel page and select `Disconnect`. You will no longer receive notifications in your Slack channel. + +

+ Slack channel disconnect option in the dropdown menu +

+ ## Get Started