some file

Notifications

NetBird can notify you when important events occur in your account, such as peers waiting for approval, routing peer disconnections, or new users joining. You can configure it under Settings > Notifications in the NetBird dashboard.

This feature is currently only available in the cloud version of NetBird.

Notifications overview showing Email, Webhook, and Slack channels

NetBird supports three notification channels:

ChannelDescription
EmailSend notifications to one or more email addresses
WebhookSend notifications as HTTP POST requests to a custom endpoint
SlackSend 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

All notification channels support the following events:

CategoryEventDescription
PeerPending ApprovalA peer is waiting for approval to join the network
PeerPeer AddedA new peer is added to the network
PeerRouting Peer DisconnectedA routing peer loses its connection
PeerRouting Peer DeletedA routing peer is deleted from the network
UserPending ApprovalA user is waiting for approval to join the network
UserUser JoinedA new user joins the account
UserService User CreatedA new service user is created
IntegrationIdP Sync Token ExpiredThe IdP sync token has expired and needs renewal
IntegrationEDR Sync Token ExpiredThe EDR sync token has expired and needs renewal

You can toggle each event on or off individually per channel.

Email Notifications

The email channel lets you send notifications to one or more email recipients.

Configure Email Notifications

  1. Navigate to Settings > Notifications and click on the Email channel.
  2. Use the Enable Email Channel toggle to enable or disable all email notifications.
  3. Under Email Addresses, enter the email address you want to receive notifications and click Add. You can add multiple recipients.
  4. Toggle individual events on or off under the Peer Notifications, User Notifications, and Integration Notifications sections.

Email notification channel configuration with recipients and event toggles

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 Microsoft Teams, PagerDuty, or custom automation systems.

Connect a Webhook

  1. Navigate to Settings > Notifications and click on the Webhook channel.
  2. Click the Connect button to open the webhook configuration modal.

Webhook channel page with Connect button

  1. In the General tab, enter the full HTTP(S) URL of your endpoint. Notification events will be sent as POST requests to this URL. Optionally, select an Authentication method for the endpoint.

Connect Webhook modal showing the General tab with endpoint URL and authentication options

  1. Click Continue to move to the Headers tab. Optionally add any custom HTTP headers your endpoint requires.

Connect Webhook modal showing the Headers tab for adding custom HTTP headers

  1. Click Connect to save the webhook.

Once connected, you can toggle individual events on or off, just like with the email channel.

Edit or Delete a Webhook

To update the webhook URL, authentication, or headers, click Edit on the webhook channel page.
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

  1. Click the Connect button to open the Slack configuration modal. In the first step, you will create a Slack App:

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

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

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