How to create an issue link to a Confluence page with the REST API

[Davin Studer]

I've seen lot's of documentation and tutorials for how to create issue links to other issues in Jira. However, I'm not finding any documentation for how to create a link to a Confluence page with the REST API. Does anyone have any experience doing this?

[Hana Kučerová · Accepted solution]

Hi @Davin Studer ,

I believe these need to be created as remote links, see here.

Request body will probably look something like this:

{
    "globalId": "appId=your-confluence-app-id&pageId=your-confluence-page-id",
    "application": {
        "type": "com.atlassian.confluence",
        "name": "your-confluence-name"
    },
    "relationship": "mentioned in",
    "object": {
         "url": "your-confluence-base-url/pages/viewpage.action?pageId=your-confluence-page-id",
         "title": "Page",
         "icon": {},
         "status": {
             "icon": {}
         }
     }
}

[Davin Studer]

Thanks. I actually found this as well by looking at the Jira REST browser and did a GET on an issue that I knew had a Confluence link and looked at the returned JSON. After a little trial and error I was able to get it working.

[Leon Lehmann]

How do you get the Confluence App ID? I am trying to create a remote issue link in a forge app while handling an issue event in Jira, but can't find a way to retrieve the Confluence App ID.