Issue Field

This module allows the app to add a new issue field to Jira.

The key of the field, that can be used to reference the field in the REST API, is: $(app-key)__$(module-key).

Available options for fields of the single_select or multi-select type are managed with the REST API for issue field options.

ISSUE_CHANGED event

Apps can receive a frontend event notifying them that an issue changed, either by being updated or commented on. This event is only available for Jira issue view modules.

1
2
AP.events.on('ISSUE_CHANGED', function (data) {
  console.log('ISSUE_CHANGED (Connect)', data);
});

However, if you have multiple issue view modules in your app, you should use the Jira issue view background script module. This will give you a central place for fetching issue details, thus reducing the number of network requests and improving the user experience. Fetching issue details separately for every module would introduce unnecessary overhead and degrade performance.

Data shape

1
2
{
  "issueId": string,
  "projectId": string,
  "changes": [{
    "changeType": "updated" | "commented",
    "atlassianId": string
  }]
}

• issueId - ID of the issue the app is rendered on
• projectId - ID of the project the issue belongs to
• changes - the list of issue changes
• changeType - type of the change
• commented - a new comment was added to the page
• updated - the issue has been updated
• atlassianId - ID of the user who made the change

Limitations

• UI kit apps don't have an event system in place and so aren't supported.
• There is a delay between the moment the issue is modified and when the event is emitted. It might take up to a few seconds.
• We can't guarantee that all issue change events will be received by Jira. Therefore, the issue view may sometimes remain stale.
• When the issue is modified by the user who is currently viewing it, it will not be refreshed. This is because we assume the change was made by that same user and there is no need for an update.

Example

1
2
{
  "modules": {
    "jiraIssueFields": [
      {
        "description": {
          "value": "field with team"
        },
        "type": "single_select",
        "extractions": [
          {
            "path": "category",
            "type": "text",
            "name": "categoryName"
          }
        ],
        "name": {
          "value": "Team"
        },
        "key": "team-field"
      }
    ]
  }
}

Properties

description

Example

1
2
{
  "value": "My text"
}

Properties

key

Example

For example, an add-on which looks like:

1
2
{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.

name

Example

1
2
{
  "value": "My text"
}

Properties

type

extractions

property

Example

1
2
{
  "path": "comments.count",
  "key": "statistics",
  "type": "number"
}

Properties

template

Properties