Component schema

NotificationChannelSpec

object1 direct reference

Definition

The type of notification channel integration.

"slack""slack_bot""email""email_v2""webhook""incidentio""prometheus_webhook""betterstack""prometheus_alertmanager""opsgenie""pagerduty""jira_service_management_ops""teams_webhook""discord_webhook""google_chat_webhook""mattermost_webhook""ilert""all_quiet"

anyOfanyOf · 14 variantsrequired

Duration

Specifies the channels notification frequency.

NotificationChannelRouting

Deliberately optional. When this object is null or omitted, no routing changes are made. When it is present, the channel's routing conditions are replaced with filters. assets is read-only and ignored on writes: it is a derived back-reference listing the check rules and synthetic checks that are bound to this channel. To bind a check rule, set the dash0.com/notification-channel-ids annotation on the check rule; to bind a synthetic check, set spec.notifications.channels on the synthetic check.

Used by 1

These schemas and endpoints reference this type directly.

SchemaNotificationChannelDefinition

json

OpenAPI source123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
{
  "properties": {
    "type": {
      "$ref": "#/components/schemas/NotificationChannelType"
    },
    "config": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/SlackConfig"
        },
        {
          "$ref": "#/components/schemas/SlackBotConfig"
        },
        {
          "$ref": "#/components/schemas/EmailConfig"
        },
        {
          "$ref": "#/components/schemas/EmailV2Config"
        },
        {
          "$ref": "#/components/schemas/WebhookConfig"
        },
        {
          "$ref": "#/components/schemas/IncidentIOConfig"
        },
        {
          "$ref": "#/components/schemas/OpsgenieConfig"
        },
        {
          "$ref": "#/components/schemas/PagerDutyConfig"
        },
        {
          "$ref": "#/components/schemas/TeamsWebhookConfig"
        },
        {
          "$ref": "#/components/schemas/DiscordWebhookConfig"
        },
        {
          "$ref": "#/components/schemas/GoogleChatWebhookConfig"
        },
        {
          "$ref": "#/components/schemas/MattermostWebhookConfig"
        },
        {
          "$ref": "#/components/schemas/IlertConfig"
        },
        {
          "$ref": "#/components/schemas/AllQuietConfig"
        }
      ]
    },
    "frequency": {
      "$ref": "#/components/schemas/Duration",
      "description": "Specifies the channels notification frequency.\n",
      "default": "10m"
    },
    "routing": {
      "$ref": "#/components/schemas/NotificationChannelRouting",
      "description": "Deliberately optional. When this object is null or omitted, no routing changes are made. When it is present, the channel's routing conditions are replaced with `filters`.\n`assets` is read-only and ignored on writes: it is a derived back-reference listing the check rules and synthetic checks that are bound to this channel. To bind a check rule, set the `dash0.com/notification-channel-ids` annotation on the check rule; to bind a synthetic check, set `spec.notifications.channels` on the synthetic check."
    }
  },
  "required": [
    "type",
    "config"
  ]
}