/api/v1/notifications/channels/{id}/

ViewSet for managing notification channels.

Notification channels are reusable notification targets (Apprise URLs)
that can be attached to multiple alert rules.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

A unique integer value identifying this notification channel.

Body Params

Request body for updating a notification channel.

string
length between 1 and 100

Friendly name

string
enum
  • discord - Discord
  • slack - Slack
  • pushover - Pushover
  • telegram - Telegram
  • email - Email
  • webhook - Generic Webhook
  • ntfy - ntfy
  • gotify - Gotify
  • home_assistant - Home Assistant
  • twilio - Twilio SMS
  • custom - Custom Apprise URL
string
length ≥ 1

Apprise-compatible URL

string | null

Optional description

boolean

Whether this channel supports rich formatting

boolean

If true, channel is available to all users

boolean

Whether channel is active

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json