Jira Issue notification schemes API
This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use it to get details of a notification scheme and a list of notification schemes.### About notification schemes ###A notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the `notificationSchemeEvents` object and contains pairs of `events` and `notifications`: * `event` Identifies the type of event. The events can be [Jira system events](https://support.atlassian.com/jira-cloud-administration/docs/configure-notification-schemes/) (see the *Events* section) or [custom events](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-event/). * `notifications` Identifies the [recipients](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-recipientsRecipients) of notifications for each event. Recipients can be any of the following types: * `CurrentAssignee` * `Reporter` * `CurrentUser` * `ProjectLead` * `ComponentLead` * `User` (the `parameter` is the user key) * `Group` (the `parameter` is the group name) * `ProjectRole` (the `parameter` is the project role ID) * `EmailAddress` *(deprecated)* * `AllWatchers` * `UserCustomField` (the `parameter` is the ID of the custom field) * `GroupCustomField`(the `parameter` is the ID of the custom field)
Jira Issue notification schemes API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Issue Notification Schemes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.
This API exposes 8 operations across 6 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.
Requests are made against a single base URL, https://your-domain.atlassian.net.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Jira Issue notification schemes API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes.
It accepts HTTP basic authentication (basicAuth).
OAuth2— OAuth2 scopes for JirabasicAuth— You can access this resource via basic auth.
Paths & Operations 8
Across 6 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events.
Schemas 27
The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are ProjectRole (11 properties), UserDetails (10 properties), FieldDetails (10 properties), EventNotification (10 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Jira 12
Other APIs Jira publishes across the network.
This is an independent, third-party profile of Jira Issue notification schemes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.