Setting up Jira Integration

Prerequisite: connection between Zephyr and Jira

In order for Zephyr and Jira to be able to exchange data, they should be accessible to each other via network. This is especially important if you use an On-Premise (Server) instance of Zephyr and a Cloud instance of Jira, or vice versa. To provide the connection, you may need to configure proxies and firewalls working in your network. See Connection Between Server and Cloud Instances.

 1. Configure connection to Jira

The connection to Jira that you set up in Zephyr Enterprise can use either OAuth, or Basic authentication (the Basic authentication is called cookie-based authentication in Zephyr UI).

The connection type to use depends on the Jira instance type you use.
Follow the links below to learn how to configure the connection parameters:

Jira Cloud
OAuth authentication

Jira Server / Data Center
OAuth, or
Basic (cookie-based) authentication
_{Tip: Basic authentication is simpler, but OAuth is more secure.}
^{We recommend using OAuth connections where possible.}

2. Configure your Zephyr project

After you configured Jira connection, you need to map your Zephyr project to a Jira project:

1. Log in to Zephyr Enterprise as a user with administrator permissions. Then, go to Administration > Project setup settings:

   Open

   

    

2. On the Project setup tab, select your project and scroll the page down to the Edit Project section.

3. In the Requirements & Defect Tracking box, select the Jira connection you created on the previous step:

   Open

   

   Choose carefully. Selecting another defect tracker later, after you map Zephyr items to Jira tickets, might be problematic.
   
   

4. Confirm the connection in the subsequent message box:

    

5. Zephyr will load a list of projects from your Jira instance and will show it in the Map external Defect project drop-down list (this list is invisible until you select a Jira instance for your project).

   Select the Jira project in that list to link it to your Zephyr project:

6. Scroll the page down and click Save to save the changes you’ve made.

Congratulations! You’ve mapped your Zephyr project to a Jira project.

Note about a webhook

If you created an OAuth connection, then during the project mapping, Zephyr automatically creates a pre-configured webhook on the Jira side. This webhook is used in communication between Zephyr and Jira. You can view it in Jira settings: go to > System (under Jira Settings) > Webhooks (under Advanced).

Don’t delete this webhook, and don’t change its properties. It has all the needed settings enabled.

Further steps

After you set up the integration, you may need to configure certain settings in Jira and to provide better support for Jira custom fields:

  Jira Management Preferences

See Also

View and configure Jira Connections in Zephyr Enterprise
Jira Integration