How do I connect with Jira?

Tags: Flow

This is a guide on how to connect your Jira Cloud or Jira self-hosted account to Flow.

When Jira and Flow are connected, Flow receives data from Jira, including:

  • Ticket data including keys, titles, bodies, and comments
  • User information including name and email
  • Project names
  • Ticket states, labels, and sprints

If your Jira account is behind a firewall, complete the following before connecting to Flow:

  1. Allowlist our IP addressesnover port 443
  2. Valid SSL certificate that uses a public certificate authority (CA)
  3. Public DNS resolution

Who can use this?

 Core
Plus
 
  


Important: We strongly recommend you use a service account to create this Integration. See How to create a service account for instructions and information about why service accounts are important.


Permissions

To connect your Jira account to Flow, the service account must be a Jira administrator. Flow requires administrator privileges in Jira to receive project ticket data and metadata.

In Jira, the service account must be the member of a group that can create issues in each project in Jira. That group must be assigned to each project. Learn more about restricting project access (opens in new tab) and assigning groups to projects in Jira (opens in new tab).

Version Requirements

Jira version 7.13 or higher

How to connect with Jira

To connect Flow with Jira:

  1. Click Settings in the top navigation bar of Flow.
  2. In the left navigation under Integrations, click Integrations.
  3. Click the Add Integration button in the top right corner of the integrations page.
  4. Choose one of three ways to connect your Jira instance.

    OAuth establishes a connection to Flow via an application link.

Access token establishes a connection to Flow via an access token.

Username/password establishes a connection to Flow with your Jira credentials. Jira has begun deprecating username and password authentication. We strongly suggest you connect to Jira via OAuth or Access Token.

OAuth

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.

  1. Paste the Jira account's base URL into the Base URL field. It looks something like: https://[your company].atlassian.net.
  2. Click Get Keypair.
  3. If the test is successful, you will be provided the credentials you need for your application link in Jira.
  4. Click the Open button under the first step. This takes you to the page in Jira you will need for the next steps. If you are prompted to log in, do so with administration credentials.
  5. Copy and paste the following URL into the field under Configure Application

    Links: https://jira.flow.pluralsight.com

  6. An advisory box appears. Confirm the URL is accurate.
  7. Click Continue.
  8. In Jira, enter GitPrime into the Application Name box.
  9. Application type defaults to Generic Application. Leave it as Generic Application.
  10. Do not populate any other fields.
  11. Click Continue.
  12. This takes you to another modal in Jira. Enter the Consumer Key, Consumer Name, and Public Key provided by Flow.
  13. Click Continue. This establishes the application link in Jira. You will see the application link added to the list.

    Note: All of this information can be found on the modal you have been using to connect Flow to 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.
  14. Back in Flow, click Test Connection.
  15. On the Jira authorization page, click Allow. This establishes the connection on the Flow side to Jira. After this is done, the page will show success.
  16. Click Next.

Access Token

To generate a personal access token, navigate to Manage your Account in Jira.

To find this page in Jira:

  1. Click on Profile from your personal settings menu.
  2. Click Manage your account on your Profile page.
  3. Click Security in the left navigation.
  4. Click Create and manage API tokens.
  5. On the API tokens page, click Create API token.
  6. Name the token.
  7. Click Create.
  8. Copy your token to your clipboard.
  9. 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 - Enter your email address.
    • Access token- Paste your API token here
    • Base URL - Enter your Jira URL

      You successfully connected your account.
  10. Click Next to finalize your integration.

Final steps

  1. Select the services you want to integrate from Jira. The only option here is tickets. Leave that on.
  2. Click Next.
  3. Enter your name for the Jira integration.
  4. Click Create.
  5. A Successfully Created banner is displayed once the connection is established.

Toggle the Import button to on for each project to import the projects you want to track in Flow. By default, all projects are set to import off.

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

  • Auto Import all projects - Turning this on auto imports all projects and continues to import new projects if applicable.
  • Pause all imports - This keeps new data from being imported. This does not remove existing data.
  • Refresh - This refreshes all ticket projects and discovers any new projects not already displayed in your Project list.
  • Settings - Click Settings to pause or turn off ticket ingestion. Toggle Ticket Services to off to remove all data associated with this Integration. Pausing this service will pause ingestion of new data.

To view and manage your imported Jira projects:

  1. Click Settings then
  2. 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 receive an error message when testing your connection during the setup process, 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 are 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.
  • Confirm the email address you provided is the same email address associated with your Jira account.

Jira self-hosted

  • Ensure you are using Jira 713 or higher.

back to top


If you need help, please email Support (opens email form) for 24/7 assistance.