Skip to main content

CreateNotificationChannelRequest

namestringrequired

Possible values: non-empty and <= 128 characters

typeNotificationChannelTyperequired

Possible values: [email, gotify, ntfy, discord, webhook]

enabledbooleanrequired
secretstring

The channel's credential, e.g. an SMTP password, a Gotify app token, an ntfy auth token, a Discord webhook URL, or a generic webhook's auth header value. Encrypted with the machine key before it reaches the database and never returned by any later read.

emailHoststring
emailPortinteger<int32>

Possible values: >= 1 and <= 65535

emailUsernamestring
emailFromstring
emailTostring[]
emailStartTlsboolean
gotifyUrlstring
ntfyUrlstring
ntfyTopicstring
webhookUrlstring
webhookMethodNotificationWebhookMethod

Possible values: [POST, PUT]

webhookHeaders object
property name*string
webhookAuthHeaderNamestring
CreateNotificationChannelRequest
{
  "name": "string",
  "type": "email",
  "enabled": true,
  "secret": "string",
  "emailHost": "string",
  "emailPort": 0,
  "emailUsername": "string",
  "emailFrom": "string",
  "emailTo": [
    "string"
  ],
  "emailStartTls": true,
  "gotifyUrl": "string",
  "ntfyUrl": "string",
  "ntfyTopic": "string",
  "webhookUrl": "string",
  "webhookMethod": "POST",
  "webhookHeaders": {},
  "webhookAuthHeaderName": "string"
}