Atlassian · Schema

NotificationEvent

Details about a notification event.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
description string The description of the event.
id integer The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/A
name string The name of the event.
templateEvent object The template of the event. Only custom events configured by Jira administrators have template.
View JSON Schema on GitHub

JSON Schema

atlassian-notificationevent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NotificationEvent",
  "title": "NotificationEvent",
  "additionalProperties": false,
  "description": "Details about a notification event.",
  "properties": {
    "description": {
      "description": "The description of the event.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/AIlKLg).",
      "format": "int64",
      "type": "integer"
    },
    "name": {
      "description": "The name of the event.",
      "type": "string"
    },
    "templateEvent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotificationEvent"
        }
      ],
      "description": "The template of the event. Only custom events configured by Jira administrators have template."
    }
  },
  "type": "object"
}