Example: Get Jira Issue Information on a Confluence Page

Information on creating a macro that will pull Jira issue information onto a specified Confluence page.

You can create a macro to pull Jira issue information onto your Confluence page.

Create the macro

Select Create Custom Macro.
Enter a Name to identify the Macro, like JiraIssue Information.
Enter an optional Description, like Get the issue ID and issue summary on your Confluence page.
Select Enabled to allow the macro to be added to pages.
Select None for Body Type.
Pick Block for Output Type.

Enter the following script into the Script to Execute field:

def issue = get("/rest/api/3/issue/${parameters.issueID}")
.asObject(Map)
.body
  
String text = "<H1>project name "+issue.fields.project.name+"</H1><br>" +
              "<H3>issue ID ${issue.key} </h2> <br>" +
              "<H3>issue Summary : ${issue.fields.summary} </h2>"
  
return text

Note: Access custom field values

If you want to access custom field values from a Jira issue and return the info back on a Confluence page, use the example code below:

String text = "<H1>project name "+issue.fields.project.name+"</H1><br>" +
"<H3>issue ID ${issue.key} </H3> <br>" +
"<H3>issue Summary : ${issue.fields.summary} </H3>" +
"<H3>Multi select custom field value : ${issue.fields.customfield_10073.value} </H3>" +
"<H3>Single Line text custom field value : ${issue.fields.customfield_10082} </H3>"

Select Add Parameter.
- When the window appears, fill out the following fields:
  1. Type: String
  2. Name: issueID
  3. Description ID: Issue ID
- Check the box for Required.
- Click Save.

The macro immediately appears on the main Macros page:

Users in your instance can now add it to Confluence pages. When it's added, the user sees the issueID parameter, where they enter the issue ID.

Once an issue ID is added to the field and the page is saved, the macro appears like this: