By integrating Jira with DX, you can analyze issues, resource allocation, sprint metrics, cycle times, and initiative progress. Please visit our schema explorer to see what data DX imports.

Prerequisites

To connect Jira to DX, you need:

a Jira service account
if your Jira instance is behind a firewall or has IP restrictions, you need to allowlist DX IP addresses

Setup instructions

Follow the steps below to connect Jira to DX.

Step 1

Create a user account in Jira to act as a service account for DX.
The service account must have access to the projects that you want to import.

Step 2

Navigate to the new connection form in DX.
Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.

API Reference

Endpoint URL	Documentation Link
/rest/api/2/project	Get All Projects
/rest/api/2/project/{projectIdOrKey}	Get Project
/rest/api/2/priority	Get Priorities
/rest/api/2/universal_avatar/type/{type}/owner/{ownerId}	Get Avatars
/rest/api/2/resolution	Get Resolutions
/rest/api/2/status	Get Statuses
/rest/api/2/field	Get Fields
/rest/api/2/group/{groupname}?includeInactiveUsers=&startAt=	Get Users From Group
/rest/api/2/issue/{issueIdOrKey}	Get Issue
/rest/api/2/groups/picker	Find Groups

Errors

The table below lists potential error codes when adding a connection in DX.

Error	Description
`invalid_credentials`	Your API credentials entered are not valid.
`invalid_permissions`	Your API token does not have the permissions required by DX.
`no_resources`	Your service account does not have access to any projects or repositories.

Troubleshooting

Story points are not being populated on Jira issues

DX ingests issue story points by looking at the following fields, in order. Once a valid number value is found, the subsequent look ups are skipped.

Jira's official story point field
Custom fields with a name that contains two asterisks
Custom fields with a name that contains the case-insensitive substring "story point"

If you are not using Jira's official story point field, have multiple custom fields with the substring "story point" in their names, or are using a custom field that does not have the substring "story point" in it's name; please add two asterisks to the name of the field you want DX to ingest.

Example 1

A customer has a two custom fields that tracks story points. One called "Estimated Story Points" and another called "Actual Story Points". They would like DX to ingest the "Actual Story Points" field, so they edit the name to include two asterisks, "Actual Story Points**".

Example 2

A customer uses a custom field called "Effort" to track their story points. They would like DX to ingest this field, so they edit the name to include two asterisks, "Effort**".