Issue Background Script

This module lets your app render a hidden panel in the new issue view in order to listen for events, poll for changes, or otherwise run code that consumes the JavaScript API. This allows your app to execute its required functionality without adding unnecessary UI elements to the issue view.

The hidden panel behaves similarly to the web panel module in that it can reload on issue status transition and issue refresh depending on the value you assign to the shouldReloadOnRefresh property.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "modules": {
    "jiraBackgroundScripts": [
      {
        "url": "/issue-background-task-script",
        "location": {
          "type": "issue_view",
          "shouldReloadOnRefresh": true
        },
        "key": "my-issue-background-script"
      }
    ]
  }
}

Properties

key

Type
string
Max length
100
Required
Yes
Pattern
^[a-zA-Z0-9-]+$

location

Type
object
Required
Yes
Description

Specifies where the background script will be located inside Jira, and any location-specific configuration. Currently, a background script can only be located in the new issue view.

Read about Issue Background Script Location.

url

Type
string
Format
uri-template
Required
Yes
Description

The URL of the app resource that serves the iframe containing the background script. As with other app iframes, the iframe must load all.js. This URL does not support context parameters. This URL must be relative to the app's baseUrl.