Skip to main content

NotificationChannel

Never carries a credential — hasSecret is the only signal that one is configured. Only the properties relevant to type are meaningful; the rest are absent.

idstring<uuid>required
namestringrequired

Possible values: non-empty and <= 128 characters

typeNotificationChannelTyperequired

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

enabledbooleanrequired
hasSecretbooleanrequired

Whether a credential is configured for this channel.

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

The header carrying the generic webhook's credential, e.g. Authorization — the header's value is secret, never a plain property here.

createdAtstring<date-time>required
updatedAtstring<date-time>required
NotificationChannel
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "type": "email",
  "enabled": true,
  "hasSecret": true,
  "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",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}