Last updated Sep 17, 2025

Ending Connect support

You can no longer publish Connect apps on the Atlassian Marketplace. All new extensibility features will be delivered only on Forge.

Refer to this blog post for our timeline to end Connect support.

Have an existing Connect app? You can incrementally migrate it to Forge.

Web Panel

Adds a panel (or section) to a page in the Atlassian application. Panels let you present related information and controls in the application interface as a group. For example, the existing "People" panel in Jira issue view shows the assignee, reporter, and similar information for the issue.

Example

1
2
{
  "modules": {
    "webPanels": [
      {
        "url": "/web-panel",
        "location": "atl.jira.view.issue.right.context",
        "layout": {
          "width": "10px",
          "height": "100%"
        },
        "weight": 50,
        "supportsNative": false,
        "name": {
          "value": "My Web Panel"
        },
        "key": "my-web-panel"
      }
    ]
  }
}

Properties

key

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.

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

Type	string
Max length	100
Required	Yes
Description	Location in the application interface for this panel. Find product locations with the Extension Point Finder Jira Locations Confluence locations You can also find all Confluence locations on this page.

name

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 i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

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

Properties

value

Type	string
Max length	1500
Required	Yes
Description	The human-readable default value. This will be used if no translation exists. Only the following HTML tags are supported: `b`, `i`, `strong`, `em`, and `code`.

i18n

Type	string
Max length	300
Description	The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

url

Type	string
Format	uri-template
Required	Yes
Description	The URL of the add-on resource that provides the web panel content. This URL must be relative to the add-on's baseUrl and can use context parameters.

cacheable

Type

boolean

Defaults to

false

Description

Returns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and lack all additional query parameters:

standard iframe query parameters
product context parameters
JWT token

conditions

Type	Single Condition, Composite Condition...
Description	Conditions can be added to display only when all the given conditions are true.

layout

Type	Web Panel Layout
Description	The width and height of the web panel on the page.

Example

1
2
{
  "layout": {
    "width": "100",
    "height": "200"
  }
}

Properties

height

Type	string
Max length	10

width

Type	string
Max length	10

params

Type	object
Description	This object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.

Example

1
2
{
  "params": {
    "someOtherProperty": "someValue",
    "myCustomProperty": "myValue"
  }
}

supportsNative

Type boolean

Defaults to false

Description

Specifies whether the web panel will be shown in the native apps. As of now, this will only support the Jira mobile and desktop clients. The web panel is required to have atl.jira.view.issue.right.context or atl.jira.view.issue.left.context as the location.

Web panels with the atl.jira.view.issue.right.context location will be shown in Jira for iOS/Mac version 109 or later and Jira for Android version 55 or later.

Web panels with the atl.jira.view.issue.left.context location will be shown in Jira for Android version 63 or later. It is not yet available in Jira for iOS/Mac but we will update this documentation when it is.

Read about enabling your addon for the Jira mobile and desktop clients.

Type i18n Property

Description

Information about the web panel that will be shown when hovering over its header

Example

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

Properties

value

Type	string
Max length	1500
Required	Yes
Description	The human-readable default value. This will be used if no translation exists. Only the following HTML tags are supported: `b`, `i`, `strong`, `em`, and `code`.

i18n

Type	string
Max length	300
Description	The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

weight

Type

integer

Description

Determines the order in which web panels appear. Web panels are displayed top to bottom or left to right in order of ascending weight. The "lightest" weight is displayed first, while the "heaviest" weights sink to the bottom. The weight values for most panels start from 100, and the weights for the links generally start from 10. The weight is incremented by 10 for each in sequence to leave room for custom panels.