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 such as keys, titles, bodies, and comments
- User information such as 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:
- Allowlist our IP addresses over port 443
- Use a valid SSL certificate that uses a public certificate authority (CA)
- Make sure you have public DNS resolution
Important: Use a service account to create this integration. Learn more about creating a service account.
Who can use this?
To connect your Jira account to Flow, the service account must have the following permissions to receive project ticket data and metadata:
- Permission to access Jira.
- Browse users and groups global permission.
- Browse projects project permission for each project.
- Create issues permission for each project.
- Issue-level security permission to view affected issues, if issue-level security is configured.
Jira permissions are complex, and your instance may have different permissions setups depending on the product and version. Learn more about the API endpoints Flow uses to collect information from Jira to check which other permissions you may need.
Note: By default, on the integration details page and the Ticket projects page, the last updated date is set from the timezone of the Jira user profile associated with the service account. If Flow does not have access to the
/rest/api/2/myself endpoint, this time will be listed in UTC.
Troubleshooting Create issues permissions
Most permissions issues with Jira are due to missing Create issues permissions. Missing this permission results in tickets appearing incorrectly in Flow, or not at all.
To verify that your service account has the correct permissions, there are a few options:
Check the permission using the Jira Admin Helper (external site, opens in new tab)
In a Jira project, navigate to the Permissions section of the Project settings and confirm that the service account is a member of a group or project role with the Create issues permission. Alternatively, the service account might be listed as a user with that permission if you aren’t using groups or project roles to manage permissions.
Team-managed Jira projects may require additional permissions and setup due to the differences in team-managed project permissions structures (external site, opens in new tab) versus company-managed Jira projects. The service account needs the same permissions in a team-managed project as in all other projects, and specifically needs the Create issues permission. In many cases, this requires adding the service account as a Member or Administrator to each team-managed project you wish to see data for in Flow.
The most common signal of a missing Create issues permission is the inability to set ticket type assignments during the ticket project configuration.
Tip: If you cannot set ticket type assignments on any project in your Jira integration, the issue is likely a globally missing Create issues permission for the service account. If there are only specific projects experiencing the issue, those projects are likely team-managed projects and the service account should be added as a Member or Administrator to them.
Once the permissions are updated and Flow reprocesses your data, continue to configure your ticket projects as normal.
Jira version 7.13 or higher
Flow integrates with Jira Cloud, Jira Data Center, and Jira Server. Project data is available from Jira Software and Jira Work Management products. While projects from Jira Service Management will appear on the Ticket projects page, they can't be processed by Flow.
How to connect with Jira
To connect Flow with Jira:
- Click Settings in the top navigation of Flow.
- In the left navigation under Integrations, click Integrations.
- Click the Add integration button in the top right corner of the Integrations page.
- Choose one of three ways to connect your Jira instance:
- OAuth establishes a connection to Flow via an application link:
Note: Flow can only connect via OAuth version 1.0a.
Access Token establishes a connection to Flow via an access token.
Username/password establishes a connection to Flow with your Jira credentials. We strongly suggest you connect to Jira via OAuth or Access Token.
- OAuth establishes a connection to Flow via an application link:
Important: If you migrate your Jira instance from Jira self-hosted to Jira Cloud, you must create a new integration. Updating your Base URL for your existing integration doesn't update your connection and Flow can't ingest data.
Sometimes browser add-ons can interfere with this connection. If you plan to connect your Jira account via OAuth, we recommend opening Flow in an Incognito window to set up this integration. Flow can only connect using OAuth version 1.0a.
- Paste your Jira account's base URL into the Base URL field. It looks something like: https://[your company].atlassian.net.
- Click Get Keypair.
- If the test is successful, you will be provided the credentials you need for your application link in Jira.
- Click the Open button under the first step. This takes you to the page in Jira you need for the next steps. If you're prompted to log in, do so with administration credentials. Learn more about using AppLinks in Jira (external site, opens in new tab).
- Copy and paste the following URL into the field under Configure Application Links: https://jira.flow.pluralsight.com. If prompted, select the Application type as Atlassian product to ensure you're using OAuth version 1.0a. Learn more about linking to other applications in Jira (external site, opens in new tab).
- An advisory box appears. Confirm the URL is accurate.
- Click Continue.
- In Jira, enter GitPrime into the Application Name box.
- Application type defaults to Generic Application. Leave it as Generic Application.
- Do not populate any other fields.
- Click Continue.
- This takes you to another modal in Jira. Enter the Consumer Key, Consumer Name, and Public Key provided by Flow.
- Click Continue. This establishes the application link in Jira. You'll see the application link added to the list.
Note: All of this information can be found on the modal you've been using to connect Flow to Jira.
- Back in Flow, click Test Connection.
- 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.
- Click Next. Then proceed to the Final steps section of this article.
Connect to Jira via access token
Important: Connecting to Jira via access token only works for Jira Cloud. Flow cannot connect to Jira Data Center or Jira Server via access token.
- Once you have your token, return to Flow and fill in the following fields to complete your integration:
- Email—Enter your email address.
- Access token—Paste your API token here.
- Base URL—Enter your Jira URL.
- Click Next to finalize your integration.
- Choose the services you want to integrate from Jira. The only option here is tickets. Leave that status toggle set to on. If you disable tickets, Flow doesn't show any data from Jira.
- Click Next.
- Enter the name you want to give the Jira integration.
- Click Create.
- A Successfully Created banner displays once the connection is established.
Toggle the Import button On for each project to import the projects you want to track in Flow. By default, importing for all projects is set Off.
In addition to importing your projects, you can also perform the following actions 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 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:
- Click Settings.
- Click Ticket projects under Integrations.
If you receive an error message when testing your connection during the setup process, check the following and try again:
- Confirm that your base URL is correct.
- Confirm that your permissions are correct.
OAuth authentication method:
- Ensure that all fields are left blank except Application name.
- Confirm that you checked the box next to Create incoming link.
Access token authentication method:
- Confirm that you pasted your access token without additional characters or spaces before or after the token.
- Confirm that the email address you provided is the same email address associated with your Jira account.
- Confirm that you're connecting to Jira Cloud, not Jira Data Center or Jira Server. If you need to connect to Jira Data Center or Jira Server, use an alternate authentication method.
- Ensure you are using Jira 7.13 or higher.
If you need help, please contact Pluralsight Support.