Palo Alto Networks · Schema

NotifChannel

NotifChannel schema from Multi-Tenant Notifications API

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
name string Notification channel name
type string Notification channel type
emailChannelDetails object Email channel details
webhookChannelDetails object Webhook channel details
template object Channel output template
View JSON Schema on GitHub

JSON Schema

sase-multitenant-notifications-api-notif-channel-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "NotifChannel",
  "description": "NotifChannel schema from Multi-Tenant Notifications API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-notifications-api-notif-channel-schema.json",
  "type": "object",
  "properties": {
    "name": {
      "description": "Notification channel name",
      "type": "string"
    },
    "type": {
      "description": "Notification channel type",
      "type": "string",
      "enum": [
        "EMAIL",
        "WEBHOOK"
      ]
    },
    "emailChannelDetails": {
      "description": "Email channel details",
      "type": "object",
      "additionalProperties": {
        "required": [
          "emails"
        ],
        "type": "object",
        "properties": {
          "emails": {
            "description": "List of emails",
            "type": "array",
            "items": {
              "required": [
                "name",
                "emailId"
              ],
              "type": "object",
              "properties": {
                "name": {
                  "description": "Email owner name",
                  "type": "string"
                },
                "emailId": {
                  "description": "Email id",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "webhookChannelDetails": {
      "description": "Webhook channel details",
      "type": "object",
      "additionalProperties": {
        "required": [
          "urls",
          "authType",
          "token"
        ],
        "type": "object",
        "properties": {
          "urls": {
            "description": "List of Webhook URLs - do not include token in the URL",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "authType": {
            "description": "Webhook Authentication Type",
            "type": "string",
            "enum": [
              "NO_AUTH",
              "TOKEN"
            ]
          },
          "token": {
            "description": "Webhook token value",
            "type": "string"
          }
        }
      }
    },
    "template": {
      "description": "Channel output template",
      "type": "object",
      "properties": {
        "name": {
          "description": "Output channel template name",
          "type": "string"
        },
        "templateJson": {
          "description": "JSON describing the output channel template",
          "type": "string"
        }
      }
    }
  },
  "required": [
    "name",
    "type"
  ]
}