Remote Link

This module allows third-party providers to add a generic link through a public REST API and associate it with Jira issues or services.

Supplied remote link information will be presented in the right sidebar of the new Jira issue view under Releases.

This module also provides actions, which allow users to perform an action on the remote link.

Remote link information is written/deleted via REST. This API is part of the Jira Software REST documentation.

Note that the module key and name are not considered private and should therefore not contain any sensitive or personally identifiable information.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "modules": {
    "jiraRemoteLinkInfoProvider": {
      "homeUrl": "https://my-remotelink-provider.com",
      "logoUrl": "https://my-remotelink-provider.com/images/logo.svg",
      "documentationUrl": "https://my-remotelink-provider.com/docs/jira-integration",
      "actions": [
        {
          "actionId": "action-1",
          "actionLabel": {
            "value": {
              "value": "acknowledge"
            }
          },
          "templateUrl": "https://my-remotelink-provider.com/ack/{ack-id}"
        }
      ],
      "name": {
        "value": "My Remote Link Provider"
      },
      "key": "remotelink-integration"
    }
  }
}

Properties

homeUrl

Type
string
Format
uri
Required
Yes
Description

URL to the provider's homepage

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. For example, an add-on which looks like:

1
2
3
4
5
6
7
8
{
    "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.

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
3
{
  "value": "My text"
}

Properties

value
Type
string
Required
Yes
Description

The human-readable default value. This will be used if no translation exists.

i18n
Type
string
Description

The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

actions

Type
[remoteLinkProviderActionBean, ... ]
Description

Optional actions that can be performed by Jira users on the remote link

documentationUrl

Type
string
Format
uri
Description

Optional URL to documentation about the provider's Jira integration

logoUrl

Type
string
Format
uri
Description

Optional URL to the provider's logo, which will be displayed in the UI