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.
When a user uninstalls an app, all the data that the app sent to Jira is deleted. If the app is reinstalled, this data won't be added back unless the app resends historical information to Jira.
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 25
{
"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"
}
}
}
homeUrl
Type | |
Format | uri |
Required | Yes |
Description | URL to the provider's homepage |
key
Type | |
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 9
Will have a configuration page module with a URL of |
name
Type | |
Required | Yes |
Description | A human readable name. Represents a string that can be resolved via a localization properties file. You can use the same Example1 2 3 4
|
value |
| ||||||||
i18n |
|
actions
Type | |
Description | Optional actions that can be performed by Jira users on the remote link |
documentationUrl
Type | |
Format | uri |
Description | Optional URL to documentation about the provider's Jira integration |
logoUrl
Type | |
Format | uri |
Description | Optional URL to the provider's logo, which will be displayed in the UI |
Rate this page: