MtNotificationList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-mt-notification-list-schema.json",
  "title": "MtNotificationList",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-notifications-api-openapi.yml#/components/schemas/MtNotificationList",
  "type": "array",
  "items": {
    "$ref": "#/$defs/MtNotification"
  },
  "$defs": {
    "EmailChannelDetails": {
      "required": [
        "emails"
      ],
      "type": "object",
      "properties": {
        "emails": {
          "description": "List of emails",
          "type": "array",
          "items": {
            "$ref": "#/$defs/EmailDetails"
          }
        }
      }
    },
    "EmailDetails": {
      "required": [
        "name",
        "emailId"
      ],
      "type": "object",
      "properties": {
        "name": {
          "description": "Email owner name",
          "type": "string"
        },
        "emailId": {
          "description": "Email id",
          "type": "string"
        }
      }
    },
    "MtNotifAggKey": {
      "required": [
        "tsgId",
        "notifType",
        "category",
        "subCategory",
        "inAppFlag"
      ],
      "type": "object",
      "properties": {
        "tsgId": {
          "description": "TSG Id",
          "type": "string"
        },
        "notifType": {
          "description": "Notification Type",
          "type": "string",
          "enum": [
            "INCIDENTS",
            "UPGRADES",
            "ANNOUNCEMENTS"
          ]
        },
        "category": {
          "description": "Notification category - is associated with notification type",
          "type": "string"
        },
        "subCategory": {
          "description": "Notification sub-category - is associated with notification type and notification category",
          "type": "string"
        },
        "inAppFlag": {
          "description": "InApp Notification Flag",
          "type": "boolean"
        }
      }
    },
    "MtNotification": {
      "required": [
        "name",
        "body",
        "aggKey",
        "notifReadState",
        "impactedTenants",
        "impactedTenantCount",
        "notifChannels"
      ],
      "type": "object",
      "properties": {
        "id": {
          "description": "Notification id",
          "type": "string"
        },
        "name": {
          "description": "Notification name",
          "type": "string"
        },
        "body": {
          "description": "Description of the notification",
          "type": "string"
        },
        "action": {
          "description": "Action to be taken on receiving the notification (if applicable)",
          "type": "string"
        },
        "createdTime": {
          "description": "Notification creation time",
          "type": "number"
        },
        "aggKey": {
          "type": "object",
          "description": "Multi-Tenant Notification Aggregation Key",
          "properties": {
            "tag": {
              "$ref": "#/$defs/MtNotifAggKey"
            }
          }
        },
        "impactedTenants": {
          "description": "List of impacted tenants",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "impactedTenantCount": {
          "description": "Number of tenants impacted by the multi-tenant notification",
          "type": "number"
        },
        "notifReadState": {
          "$ref": "#/$defs/NotifReadState"
        },
        "notifChannels": {
          "description": "List of output channels that the notification is sent on",
          "type": "array",
          "items": {
            "$ref": "#/$defs/NotifChannel"
          }
        },
        "notifType": {
          "description": "Notification type",
          "type": "string"
        }
      }
    },
    "NotifChannel": {
      "required": [
        "name",
        "type"
      ],
      "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": {
            "$ref": "#/$defs/EmailChannelDetails"
          }
        },
        "webhookChannelDetails": {
          "description": "Webhook channel details",
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/WebhookChannelDetails"
          }
        },
        "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"
            }
          }
        }
      }
    },
    "NotifReadState": {
      "type": "string",
      "description": "Read state of the notification",
      "enum": [
        "READ",
        "UNREAD"
      ]
    },
    "WebhookChannelDetails": {
      "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"
        }
      }
    }
  }
}