Atlassian · Schema

NotificationRecipients

Details of the users and groups to receive the notification.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
assignee boolean Whether the notification should be sent to the issue's assignees.
groupIds array List of groupIds to receive the notification.
groups array List of groups to receive the notification.
reporter boolean Whether the notification should be sent to the issue's reporter.
users array List of users to receive the notification.
voters boolean Whether the notification should be sent to the issue's voters.
watchers boolean Whether the notification should be sent to the issue's watchers.
View JSON Schema on GitHub

JSON Schema

atlassian-notificationrecipients-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NotificationRecipients",
  "title": "NotificationRecipients",
  "additionalProperties": true,
  "description": "Details of the users and groups to receive the notification.",
  "properties": {
    "assignee": {
      "description": "Whether the notification should be sent to the issue's assignees.",
      "type": "boolean"
    },
    "groupIds": {
      "description": "List of groupIds to receive the notification.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "groups": {
      "description": "List of groups to receive the notification.",
      "items": {
        "$ref": "#/components/schemas/GroupName"
      },
      "type": "array"
    },
    "reporter": {
      "description": "Whether the notification should be sent to the issue's reporter.",
      "type": "boolean"
    },
    "users": {
      "description": "List of users to receive the notification.",
      "items": {
        "$ref": "#/components/schemas/UserDetails"
      },
      "type": "array"
    },
    "voters": {
      "description": "Whether the notification should be sent to the issue's voters.",
      "type": "boolean"
    },
    "watchers": {
      "description": "Whether the notification should be sent to the issue's watchers.",
      "type": "boolean"
    }
  },
  "type": "object"
}