What does it do?
The Betterworks JIRA integration captures data from JIRA and automatically updates progress of your key results or milestones in Betterworks every 30 minutes. Any JIRA issue can be supported in Betterworks JIRA Integration, including including stories and epics.
The JIRA integration can track the progress of individual issues or large projects. Linking these items to a key result in Betterworks via the integration can be accomplished in two ways:
- Manually adding issues via a basic search or JQL query
- Setting up a JQL query to capture all the issues matching the string
Anyone who uses JIRA to track tasks, features or projects in their workflow can benefit from this integration. For instance, engineers use it to show bugs that they have to squash and product managers use it to track the shipment of features by setting up a JQL query to capture overall progress.
Important: The Betterworks JIRA integration is only available in our production environment and is managed by Admins and Super Admins. It is not available in demo, trial, or preview environments.
To add the JIRA integration to Betterworks, you need to connect a JIRA user in the Betterworks integration page.
- Create a JIRA user with the appropriate set of permissions for Betterworks users. Read-only permissions are sufficient. Users within Betterworks will be able to see the JIRA issue, name, and resolution for every project that is available to that JIRA user. No other details from the JIRA instance are captured by Betterworks. For more information on creating JIRA users, read JIRA’s documentation.
- Navigate to the Betterworks Integrations page by going to Admin > Third Party Integrations.
- Now, next to the JIRA integration section from the list, click Set Up.
- Next, open a new browser. If your JIRA installation is hosted by Atlassian (in the cloud):
Generate an API token in JIRA by following this link here:
Next, after generating an API Token in JIRA, go back to Betterworks platform and input the full username in the username field. (email address)
Input the API token created from JIRA into the password field.
Note: The Password field is automatically encrypted.
- Title your "Instance Name" and add your JIRA HOST URL.
If your company hosts your JIRA instance (on premise): Enter the JIRA user’s login info and the target URL of your JIRA instance. The user password is automatically encrypted. If your instance is behind a firewall, your IT department must determine a port to use and open it to allow Betterworks access to your JIRA instance. Include the port number at the end of the URL (for example, http://JIRA.yourcompany.com:1234). Alternatively, you can add the Betterworks IPs to your firewall's whitelist:
- Click Save.
- If you want to connect multiple JIRA instances, click Add another instance.
- When adding multiple instances, you can optionally enter names for each instance. The names will be used to allow users to select which instance to point to when setting up their milestones. If you do not enter names the for the instance, the domain of each instance will be used.
- Follow steps 1-6 for each additional instance.
That's it! The JIRA integration is ready to go. Just log out of betterworks and log back in to use it.
Note: In order to see the JIRA integration at work, you need to log out of your betterworks instance and log back in. The integration will not appear until you've logged out and logged back in.
How To Find the Jira Integration After Setup
The JIRA integration option can be found as follows:
Either click Create if you are creating a new OKR or click ... "Additional Actions" and then Bulk Edit for existing OKRs.
The JIRA integration option will be found only under key results (aka milestones).
If you have any questions regarding connecting betterworks to your JIRA instance, please reach out to our Customer Success team.
Troubleshooting the Integration
Please see the FAQs in our How to Use the Betterworks Jira Integration article.