How do I connect with Jira?

Tags: Flow

Overview

Below is a guide on how to connect your Jira Cloud or Jira self-hosted account to Flow. Currently, ticket activity and ticket data is only visible in the Work log report.

If your Jira account is behind a firewall, you will need to complete the following before connecting to Flow. 

  1. Whitelist our IP addresses over port 443
  2. Valid SSL certificate that uses a public certificate authority (CA)
  3. Public DNS resolution 
Important: We strongly recommend you use a service account to create this Integration. Please see How to create a service account for instructions and information about why service accounts are important.

Jira permissions requirements

In order to connect your Jira account to Flow, the service account must be a Jira administrator. Administrator permissions are required so that Flow can ingest both, ticket data, and metadata about projects being worked on.

Version Requirements

Jira version 7.13 or higher

How to connect with Jira

Step 1: On your Flow home page, go to the top navigation bar and click Settings. Using the left navigation under Integrations, click Integrations.

Step 2: Select the Add Integration button in the top right hand corner of you integrations screen.


Step 3: On the following page select Jira from the Integration Provider list and click Next.


Step 4: You can choose one of three ways to connect your Jira instance. Choose the connection that works best for your organization. 

A.) OAuth - Selecting this option you will be establishing a connection via an application link.


B.) Access Token - Selecting this option you will be establishing a connection via an access token.


C.) Username/Password - Selecting this option you will be establishing a connection using your Jira credentials. 

Jira has begun deprecating username and password authentication. We strongly suggest you connect to Jira via OAuth or Access Token.

OAuth

Tip: Sometimes browser add-ons can interfere with this connection. If you plan on connecting your Jira account via OAuth we recommend opening GitPrime in an incognito window to setup this Integration.

Step 1: Paste the Base URL from your Jira account. It will look something like: 

  • “https://[your company].atlassian.net”

Then click Get KeyPair.


Step 2: If the test is successful, you will be provided with credentials you need for your application link in Jira. 


Step 3: The button under the first step will take you to the page in Jira you will need for the next steps. If you are prompted to log in, please do so with administration credentials.


Step 4: Create a new link to Flow with the URL https://jira.flow.pluralsight.com


Step 5: An advisory box will appear.  This is expected, please confirm the URL is accurate and click Continue.


Step 6: Continuing in Jira, enter ONLY “GitPrime” into the Application Name box. Application Type will default to Generic Application. Leave it as Generic Application. Then check the box Create incoming link, and click Continue. DO NOT POPULATE ANY OTHER FIELDS.


Step 7: This will take you to another modal in Jira that will ask you to enter the Consumer KeyConsumer Name, and Public Key provided by Flow.  


Note: All of this information can be found on the modal we have been using to connect Flow to Jira.

Step 8: Once you've entered the Consumer KeyConsumer Nameand Public Key click Continue.

Step 9: Clicking Continue establishes the application link in Jira. You will see the application link added to the list.



Important: Before proceeding to the next step, make sure you have pop-ups disabled on your browser. The following steps will include a pop-up that will finalize your connection to your JIRA account. If you have pop-ups blocked, you will have to start all over.
Step 10: Back in Flow on the modal, click Test Connection.

Step 11: You will be lead to a Jira authorization page. Click Allow to establish the connection on the Flow side to Jira. After this is done the page will show success. Click on Next to continue to the final steps below.

Access Token

Step 1: In Jira, generate a personal access token by navigating to Manage your Account. You can find this page by following the steps below:

A. Click on Profile from your personal settings menu


B. Click Manage your account on your Profile page.


C. Click on the Settings menu item then Create and manage API tokens.


D. On the API tokens page click Create API token.


E. Give your token a name and click Create.


F. Copy your token to your clipboard


Step 2: Now that you have created an access token, return to Flow and fill in following fields to complete your Integration then click Test Connection.

  • Email
  • Access Token (paste your API token here)
  • Base URL - this will be your Jira URL

Step 3: Success! You have successfully connected your account.


Step 4: Click the blue Next button to finalize your Integration.


Final steps

Step 1: The next page asks what services you want to integrate from Jira. The only option here is tickets. Leave that "On" and click Next.


Step 2: Enter your name for the Jira integration and then click Create.


Step 3: The below success message will be displayed verifying your connection is complete. 


Step 4: Begin importing the projects you want to track in your reports by toggling the Import button to "on" for each project. By default all projects are set to import "off".


Step 5. In addition to importing your projects, you can also perform the following action on this integration.

A. Auto Import all project - Turning this "on" will auto import all projects and will continue to import new projects if applicable.

B. Pause all imports - This will not remove existing data, rather it will keep new data from being imported.

C. Refresh - This button will refresh all ticket projects and discover any new projects that may not be displayed already in your Project list.

D. Settings - Click Settings to pause or turn off ticket ingestion. Toggling Ticket Services to "off" will remove all data associated with this Integration. Pausing this service will pause ingestion of new data.


Step 6. You can see and manage your imported Jira projects by going to Settings then click Ticket projects under Integrations. To learn more about managing your Projects, see Managing ticket projects. To learn more about managing your new Integration settings, see Managing Integrations.

Troubleshooting 

If you are not able to connect to your Jira instance and you receive an error message when testing your connection during the setup process, please check the following and try again:

  • Confirm your base URL. Did you type it in correctly? 

  • Confirm your permissions. Are you a Jira administrator? 

OAuth authentication method:

  • Ensure that all fields were left blank except Application name. 

  • Confirm that you selected the create incoming box link in step 6. 

Access token authentication method:

  • Confirm you pasted your access token in without additional characters/spaces before or after the token. 

  • Is the email address you provided the same email address associated with your Jira account? 

Jira self-hosted

  • Are you using Jira 7.13 or higher?

back to top


If you need help, please email support@pluralsight.com for 24/7 assistance.