nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

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?

Accepted answers

Hana Kučerová

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": {}
         }
     }
}

All comments

Hana Kučerová

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_76vmb9

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.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

server

jira

jira-server