Configuring the JIRA Integration

Introduction

The Betterworks JIRA integration captures data from JIRA and automatically updates progress of your key results in Betterworks every 30 minutes. Any JIRA issue can be supported, including including stories and epics. 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
  • 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.

1.png

Setup

To add the JIRA integration to Betterworks, you'll need to connect a JIRA user in the Betterworks integration page.

1. 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, see JIRA's documentation.

2. Go to the Betterworks Integrations page:

Admin → Platform Configuration → Integrations Third-party integrations → JIRA → Set Up


2.png

3. If your JIRA installation is hosted by Atlassian (in the cloud):

  • Generate an API token in JIRA
  • In Betterworks, enter the applicable username (email address)
  • Enter the API token created from JIRA into the password field
  • Enter an "Instance Name"
  • Add your JIRA host URL

4. If your organization hosts your JIRA instance (on premises):

  • In Betterworks, enter the applicable username (email address)
  • Enter the applicable password
  • Enter an "Instance Name"
  • Add your JIRA host URL
    • If your instance is behind a firewall your organization's IT department will need to determine a port to use and open it so that the Betterworks platform can access the JIRA instance

    • Include the port number at the end of the URL (i.e. http://JIRA.company.com:1234)

    • They may also need to add the following Betterworks IPs to the firewall's whitelist:

      • 18.235.225.62/32

      • 54.198.90.129/32

      • 54.237.162.217/32

5. Click "Save".

Notes:

  • 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 done this.
  • If you'd like to connect multiple JIRA instances, click "Add another instance" and repeat the previous steps.

For information on using the JIRA integration, see this article