Embed Jira issue data in Confluence

Use the Display Issue Data - Inline macro to embed issue data from Jira into a Confluence page or blog post. The vast majority of out-of-the-box Jira issue fields and custom field types are supported. Data will be rendered inline and displayed without pagination or additional chrome so that it appears indistinguishable from surrounding content.

Ensure a connection to Jira has been set up

A connection to Jira must be set up before issue data can be embedded from that Jira site. Connections can be established to multiple Jira sites. This allows issue data from various locations to be embedded in a single Confluence page or blog post.

Add a Connection to Jira macro

Navigate to your chosen page or blog post and click the pencil icon to enter mode. Add a Display Issue Data - Connection to Jira macro to make use of the connections to Jira that have been set up. Type / (forward slash) while in edit mode, type Display Issue Data, and then select the macro from the list. This will add it to the document.

embed-data-docs-1.png

The macro can be added anywhere in the document. Only one Connection to Jira macro is needed, regardless of how many different Jira connections you want to embed issue data from.

Embed data from one or more issues

Add a Display Issue Data - Inline macro to embed specific data from one or more issues. Type / (forward slash) while in edit mode, type Display Issue Data, and then select the macro from the list. This will add it to the document.

embed-data-docs-2.png

A modal dialog will open, allowing you to search for, and select, Jira issues. Search for issues in the search box at the top. You can search by Jira issue key, plain text or JQL.

embed-data-docs-3.png

If needed you can select a different connection to Jira using the connections selector at the top right of the modal.

embed-data-docs-8.png

Select one or more Jira issues from the displayed results and then click Select fields at the bottom right.

embed-data-docs-4.png

This will display a preview of your selected issue/s. Add, remove and reorder fields using the controls at the bottom of the modal.

Add fields using the Add a field selector. To locate a specific field, type to filter the field list. Added fields immediately show in the issue preview. If an added field appears to be missing from the preview, the most likely reason is that it currently has no data. Such fields can still be embedded in Confluence - they will automatically display data if this is added in Jira.

Remove fields by clicking the x icon next to the displayed field in the fields list. Removed fields can be re-added using the Add a field selector.

Reorder fields by clicking and dragging the field in the fields list. This will immediately update the issue preview. Fields can be arranged in any order.

embed-data-docs-5.png

In the example below we have selected a single field using the controls described above. When you have finished configuring fields, click Insert to embed the issue into Confluence. This will use the field selections you have chosen.

embed-data-docs-6.png

Issue data is rendered inline so that it appears indistinguishable from surrounding content. The vast majority of out-of-the-box Jira issue fields and custom field types are supported.

embed-data-docs-7.png

Display Issue Data for Confluence docs