Jira Service Management Cloud

By integrating Jira Service Management Cloud (JSM) with DX, you can analyze incident data and metrics such as MTTR and Change Fail Rate, as well as incorporate incident data into DX scorecards. Please refer to the API documentation below and our schema explorer to see what data DX imports.

Prerequisites

To connect JSM to DX, you need:

• a JSM Managed Account
• a JSM user account with admin access

Setup instructions

Follow the steps below to connect JSM to DX:

Step 1

Create a Jira service account to be used for DX—the service account must have access to the projects that you want to import.

Step 2

Create a Scoped Token

• Begin service account creation via admin.atlassian.com under Directory → Service accounts
• Grant the service account access to the Jira App with the User Role
• When directed, specify the following scopes for the token:
  • Read:
    • read:jira-work
• Save this token to be used when connecting via DX
• Find your cloud ID to build your base API URL at https://<my-site-id>/_edge/tenant_info
  • This should show a hash with a single key value pair that looks like {"cloudId":"15ace26c-a7e9-49d6-9e1e-5e90906e946e"}
• Use https://api.atlassian.com/ex/jira/<cloud-id> as the base URL
  • eg. https://api.atlassian.com/ex/jira/15ace26c-a7e9-49d6-9e1e-5e90906e946e
• For the username, use the generated service account email. It should end in serviceaccount.atlassian.com

Step 3

Go to Settings > Issues > Issue Types and copy the name of the Incident issue type from the list which is associated with Incidents.

Step 4

• Navigate to the connections page in DX and select “+ Connection” in the top right.
• Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.
  • Your username will be an email address and API token will be a long string beginning with ‘ATATT3x’

Deprecated Authentication Alternative: Unscoped Token - To setup a connection, you can also use an unscoped API Token created using the Create API Token option under Manage API Tokens at id.atlassian.com. When using an unscoped token, you must use the <my-id>.atlassian.net version of your base URL (e.g., https://my-company.atlassian.net). We recommend using scoped tokens, but will continue accepting unscoped tokens indefinitely.

API reference

The table below lists the specific API endpoints that are used by DX.

Errors

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