Atlassian · Schema

EventNotification

Details about a notification associated with an event.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
emailAddress	string	The email address.
expand	string	Expand options that include additional event notification details in the response.
field	object	The custom user or group field.
group	object	The specified group.
id	integer	The ID of the notification.
notificationType	string	Identifies the recipients of the notification.
parameter	string	As a group's name can change, use of `recipient` is recommended. The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't imp
projectRole	object	The specified project role.
recipient	string	The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by the `notificationType` value. So, when `notificationType`
user	object	The specified user.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EventNotification",
  "title": "EventNotification",
  "additionalProperties": false,
  "description": "Details about a notification associated with an event.",
  "properties": {
    "emailAddress": {
      "description": "The email address.",
      "type": "string"
    },
    "expand": {
      "description": "Expand options that include additional event notification details in the response.",
      "type": "string"
    },
    "field": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FieldDetails"
        }
      ],
      "description": "The custom user or group field."
    },
    "group": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupName"
        }
      ],
      "description": "The specified group."
    },
    "id": {
      "description": "The ID of the notification.",
      "format": "int64",
      "type": "integer"
    },
    "notificationType": {
      "description": "Identifies the recipients of the notification.",
      "enum": [
        "CurrentAssignee",
        "Reporter",
        "CurrentUser",
        "ProjectLead",
        "ComponentLead",
        "User",
        "Group",
        "ProjectRole",
        "EmailAddress",
        "AllWatchers",
        "UserCustomField",
        "GroupCustomField"
      ],
      "type": "string"
    },
    "parameter": {
      "description": "As a group's name can change, use of `recipient` is recommended. The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by `notificationType` value. So, when `notificationType` is:\n\n *  `User` The `parameter` is the user account ID.\n *  `Group` The `parameter` is the group name.\n *  `ProjectRole` The `parameter` is the project role ID.\n *  `UserCustomField` The `parameter` is the ID of the custom field.\n *  `GroupCustomField` The `parameter` is the ID of the custom field.",
      "type": "string"
    },
    "projectRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectRole"
        }
      ],
      "description": "The specified project role."
    },
    "recipient": {
      "description": "The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by the `notificationType` value. So, when `notificationType` is:\n\n *  `User`, `recipient` is the user account ID.\n *  `Group`, `recipient` is the group ID.\n *  `ProjectRole`, `recipient` is the project role ID.\n *  `UserCustomField`, `recipient` is the ID of the custom field.\n *  `GroupCustomField`, `recipient` is the ID of the custom field.",
      "type": "string"
    },
    "user": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ],
      "description": "The specified user."
    }
  },
  "type": "object"
}