Create notification channel

post

https://example.com/api/v1/notifications/channels/

Create a new notification channel.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for creating a notification channel.

name

string

required

length between 1 and 100

Friendly name for this channel

channel_type

string

enum

required

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

apprise_url

string

required

length ≥ 1

Apprise-compatible URL for this channel

description

string

length ≤ 200

Optional description

supports_rich

boolean

Defaults to false

Whether this channel supports rich formatting

is_global

boolean

Defaults to false

If true, channel is available to all users

enabled

boolean

Defaults to true

Whether channel is active

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201