Atlassian has announced the timeline for Connect's phased end-of-support.
From Sep 17, 2025, only Forge apps can be submitted to the Atlassian Marketplace. All new extensibility features will be delivered only on Forge.
Have an existing Connect app? Find out how to incrementally adopt Forge from Connect.
Want your dashboard to automatically refresh?
Jira dashboard gadget in Forge supports auto-refresh, as well as UI Kit 2.
Already have a Connect app? Start adding Forge features in less than an hour.
Dashboard items allow add-on to display a summary information data on the dashboard. Each dashboard-item can be configured to display information relevant to a particular user.
1 2{ "jiraDashboardItems": [ { "description": { "value": "Dashboard item description" }, "url": "/dashboard-item-test?dashboardItemId={dashboardItem.id}&dashboardId={dashboard.id}&view={dashboardItem.viewType}", "configurable": true, "thumbnailUrl": "atlassian-icon-16.png", "refreshable": false, "name": { "value": "Dashboard item title" }, "key": "dashboard-item-key" } ] }
Type
| i18n Property |
Required
| Yes |
Description
|
Description of the dashboard item. This will be displayed for a user in the directory. Represents a string that can be resolved via a localization properties file. You can use the same |
1 2{ "value": "My text" }
value
|
| ||||||||
i18n
|
|
Type | string |
Max length | 100 |
Required | Yes |
Pattern | ^[a-zA-Z0-9-]+$ |
Description | A key to identify this module. This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique. Keys must only contain alphanumeric characters and dashes. The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. |
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
.
Type | i18n Property |
Required | Yes |
Description |
A human readable name. Represents a string that can be resolved via a localization properties file. You can use the same |
1 2{ "value": "My text" }
value |
| ||||||||
i18n |
|
Type | string |
Format | uri-template |
Required | Yes |
Description | URI of the dashboard item thumbnail which is displayed in the directory. |
Type | string |
Format | uri-template |
Required | Yes |
Description | The URL of the service which will render the dashboard item. Following context parameters are supported in url.
|
Type | Single Condition, Composite Condition... |
Description | Conditions can be added to display only when all the given conditions are true. |
Type | boolean |
Defaults to | false |
Description |
Specify if the dashboard-item is configurable or not. Configurable dashboard items should render configuration view if there is no configuration stored for the dashboard item. Dashboard item properties can be used for configuration storage. In addition, configurable dashboard items should register a javascript callback for
It is a common case to give users ability to set the name of the dashboard item. This can be achieved with a following JS code:
|
Type
|
boolean
|
Defaults to
|
false
|
Description
|
With this setting, the iframe will no longer be reloaded on refresh, and instead you can register a callback that listens for refresh events. This callback will then be triggered each time the entire dashboard is refreshed and when the gadget-specific refresh button is clicked.
|
Rate this page: