NetBird Full API Reference + Read-Only MCP Prototype
POST/api/integrations/notifications/channels

Create Notification Channel

Creates a new notification channel for the authenticated account. Supported channel types are email and webhook.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields
enabledbooleanrequired
Whether this notification channel is active.
event_typesarray<string>required
List of activity event type codes this channel subscribes to.
targetobjectoptional
Channel-specific target configuration. The shape depends on the `type` field: - `email`: requires an `EmailTarget` object - `webhook`: requires a `WebhookTarget` object
typestringrequired
The type of notification channel.
Allowed:emailwebhook

6 status codes
200Notification channel created successfully.
enabledbooleanrequired
Whether this notification channel is active.
event_typesarray<string>required
List of activity event type codes this channel subscribes to.
idstringrequired
Unique identifier of the notification channel.
targetobjectoptional
Channel-specific target configuration. The shape depends on the `type` field: - `email`: an `EmailTarget` object - `webhook`: a `WebhookTarget` object
typestringrequired
The type of notification channel.
Allowed:emailwebhook
400Bad Request
401Requires authentication
403Forbidden
404Resource not found
500Internal Server Error

Error handling

A 400 is returned: Bad Request. A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 500 is returned: Internal Server Error.