Background Script

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

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
{
  "modules": {
    "jiraBackgroundScripts": [
      {
        "url": "/issue-background-task-script",
        "location": {
          "type": "issue_view",
          "shouldReloadOnRefresh": true
        },
        "key": "my-issue-background-script"
      }
    ]
  }
}

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.

location

url