The location in the application interface where the web item should appear. For the Atlassian application interface, a location is something like the coordinates on a map. It points to a particular drop-down menu or navigation list in the UI.

Places in the Atlassian UI are identified by what are known as "well-known locations". For example, the system.admin/globalsettings location is in the administrative menu on the left side of the Administration Console.

Product location documentation:

• JIRA locations
• Confluence locations

A human readable name.

A key to identify this module. This key must be unique relative to the add on.

All specified keys will have all special characters and spaces replaced with dashes and will be lower cased.

example: "My Addon Key" will become "my-addon-key"

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:

{
    "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.

Specifies the URL targeted by the web item. The URL can be absolute or relative to either the product URL or the add-on's base URL, depending on the context attribute.

Your add-on can receive additional context from the application by using variable tokens in the URL attribute.

Conditions can be added to display only when all the given conditions are true.

The context for the URL parameter, if the URL is specified as a relative (not absolute) URL.

This context can be either addon, which renders the URL relative to the add-on's base URL, page which targets a page module by specifying the page's module key as the url or product, which renders the URL relative to the product's base URL.

An optional icon to display with the link text or as the link, specified by URL to its hosted location. You can specify a particular width and height for the icon. Most link icons in Atlassian applications are 16 by 16 pixels.

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

Example

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

Specifies custom styles for the web item target page, if desired. By default, the web item content gets styled in the default style of the target application.

The internationalised text to be used in the link's tooltip.

Defines the way the url is opened in the browser, such as in a modal or inline dialog. If omitted, the url behaves as a regular hyperlink.

{
  "target": {
    "type": "inlinedialog",
    "options": {
      "onHover": true,
      "offsetY": "20px",
      "offsetX": "30px"
    }
  }
}

Determines the order in which the web item appears in the menu or list.

The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.

Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.