Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 63 additions & 5 deletions src/pages/manage/settings/notifications.mdx
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -12,21 +12,22 @@ NetBird can notify you when important events occur in your account, such as peer
</Note>

<p>
<img src="/docs-static/img/manage/settings/notifications/netbird-settings-notifications-overview.png" alt="Notifications overview showing Email and Webhook channels" className="imagewrapper-big"/>
<img src="/docs-static/img/manage/settings/notifications/netbird-settings-notifications-overview.png" alt="Notifications overview showing Email, Webhook, and Slack channels" className="imagewrapper-big"/>
</p>

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 |
|----------|-------|-------------|
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -97,6 +98,63 @@ To remove the webhook entirely, click `Delete`.
<img src="/docs-static/img/manage/settings/notifications/netbird-notifications-webhook-edit-delete.png" alt="Webhook channel page showing Edit and Delete options for a connected webhook" className="imagewrapper"/>
</p>

## 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.

<p>
<img src="/docs-static/img/manage/settings/notifications/netbird-notifications-slack-channel.png" alt="Slack notification channel page with Connect button" className="imagewrapper"/>
</p>

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`.

<p>
<img src="/docs-static/img/manage/settings/notifications/netbird-notifications-slack-create-app.png" alt="Connect NetBird with Slack - Step 1: Create a Slack App" className="imagewrapper"/>
</p>

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

<p>
<img src="/docs-static/img/manage/settings/notifications/netbird-notifications-slack-name-workspace.png" alt="Slack app creation - naming and workspace selection" className="imagewrapper"/>
</p>

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`.

<p>
<img src="/docs-static/img/manage/settings/notifications/netbird-notifications-slack-incoming-webhooks.png" alt="Slack Incoming Webhooks settings page" className="imagewrapper"/>
</p>

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

<p>
<img src="/docs-static/img/manage/settings/notifications/netbird-notifications-slack-webhook-url-copy.png" alt="Copying the Slack webhook URL" className="imagewrapper"/>
</p>

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

<p>
<img src="/docs-static/img/manage/settings/notifications/netbird-notifications-slack-webhook-url.png" alt="Connect NetBird with Slack - Step 2: Enter Webhook URL" className="imagewrapper"/>
</p>

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.

<p>
<img src="/docs-static/img/manage/settings/notifications/netbird-notifications-slack-disconnect.png" alt="Slack channel disconnect option in the dropdown menu" className="imagewrapper"/>
</p>

## Get Started
<div float="center" >
<Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Use NetBird</Button>
Expand Down
Loading