Below is a guide on how to connect your Jira Cloud or Jira self-hosted account to Flow.
If your Jira account is behind a firewall, you will need to complete the following before connecting to Flow.
- Allowlist our IP addresses over port 443
- Valid SSL certificate that uses a public certificate authority (CA)
- Public DNS resolution
Who can use this?
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.
Permissions requirements in Jira
To connect your Jira account to Flow, the service account must be a Jira administrator. Administrator permissions in Jira are required so that Flow can ingest both ticket data and metadata about projects.
In Jira, the service account must be the member of a group that has the ability to create issues in each project in Jira. That group must be assigned to each project. Learn more about restricting project access and assigning groups to projects in Jira.
Jira version 7.13 or higher
How to connect with Jira
- On your Flow home page, go to the top navigation bar and click Settings. Using the left navigation under Integrations, click Integrations.
Select the Add Integration button in the top right hand corner of your integrations screen.
- Select the Add Integration button in the top right hand corner of your integrations screen.
You can choose one of three ways to connect your Jira instance. Choose the connection that works best for your organization.
- ChoosingOAuth establishes a connection to Flow via an application link.
Choosing access token establishes a connection to Flow via an access token.
Choosing 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.
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.
- Paste the Base URL from your Jira account. It will look something like:
- “https://[your company].atlassian.net”
- Then click Get Keypair.
- In Jira, generate a personal access token by navigating to Manage your Account. You can find this page by following the steps below:
- Click on Profile from your personal settings menu
- Click Manage your account on your Profile page.
- Access Token (paste your API token here)
- Base URL - this will be your Jira URLSuccess! You have successfully connected your account.
- Click the blue Next button to finalize your Integration.
- The next page asks what services you want to integrate from Jira. The only option here is tickets. Leave that "On" and click Next.
- Enter your name for the Jira integration and then click Create.
- The below success message will be displayed verifying your connection is complete.
- 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".
- In addition to importing your projects, you can also perform the following action on this integration.
- Auto Import all projects - Turning this "on" will auto import all projects and will continue to import new projects if applicable.
- Pause all imports - This will not remove existing data, rather it will keep new data from being imported.
- Refresh - This button will refresh all ticket projects and discover any new projects that may not be displayed already in your Project list.
- 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.
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.
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?
Are you using Jira 7.13 or higher?
If you need help, please email email@example.com for 24/7 assistance.