NotificationChannel data model
Webhook notifications include other_address_failing and other_address_recovery events. Their additive metadata fields are described by OtherAddressWebhookMetadata.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | |
name | string | No | |
type | string | No | One of: EMAIL, SLACK, PAGERDUTY, WEBHOOK, SMS, DISCORD, TEAMS, WHATSAPP, TELEGRAM, OPSGENIE, PROMETHEUS, PUSH. |
enabled | boolean | No | |
config | object | No | Channel-specific configuration. Secret values come back masked (see the channel read endpoints); sending a masked value back on update keeps the stored one. |
createdAt | string (date-time) | No |
Used by
- List notification channels:
GET /api/notification-channels - Create notification channel:
POST /api/notification-channels - Get notification channel:
GET /api/notification-channels/{id}
Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json.