CreateNotificationChannelRequest data model
The CreateNotificationChannelRequest shape in the Visual Sentinel REST API.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Max length 100. |
type | string | Yes | One of: EMAIL, SLACK, DISCORD, TEAMS, PAGERDUTY, OPSGENIE, WEBHOOK, WHATSAPP, TELEGRAM, PROMETHEUS, PUSH. |
enabled | boolean | No | Default: true. |
config | object | Yes | Channel settings. EMAIL: { recipients: [email] }. SLACK, DISCORD, TEAMS: { webhookUrl }. PAGERDUTY: { integrationKey }. OPSGENIE: { apiKey }. WEBHOOK: { url, method?, headers?, secret?, payloadTemplate? }. TELEGRAM: { botToken, chatId }. WHATSAPP: { phoneNumbers, phoneNumberId, accessToken }. PROMETHEUS: { alertmanagerUrl, basicAuth?, labels? }. PUSH: { subscriptions }. |
alertTypes | array of string | No | Alert kinds this channel receives. Empty means all. Items are one of: DOWNTIME, SLOW_RESPONSE, VISUAL, PERFORMANCE, SSL, DNS, DOMAIN, CONTENT. Default: []. |
isDefault | boolean | No | Use this channel for monitors that have no channels of their own. Default: false. |
Used by
- Create notification channel:
POST /api/notification-channels - Update notification channel:
PUT /api/notification-channels/{id}
Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json.