Palo Alto Networks · JSON Structure

Sase Multitenant Notifications Api Notif Channel Structure

NotifChannel schema from Multi-Tenant Notifications API

Type: object Properties: 5 Required: 2
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

NotifChannel is a JSON Structure definition published by Palo Alto Networks, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name type emailChannelDetails webhookChannelDetails template

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

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