Jira Integration

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-administration-guides/system-setup/jira-integration.html

Why integrate?

If your team uses Jira, you may want to integrate your Zephyr Enterprise project with it. This will enable your teammates to –

Create bug reports in Jira from the Zephyr UI right after the test run.
Link requirements, test cases and other items to Jira tickets.
Import data from Jira tickets as defects, requirements, or test cases into your Zephyr project.

The changes you make to Jira tickets in Zephyr will be visible in Jira and vice versa, the changes you make to tickets’ fields in Jira will be visible in Zephyr.

Haven’t used Zephyr Enterprise yet?

Start a free trial now

Supported Jira versions

Zephyr Enterprise integrates with –

Jira Cloud, and
Jira Server / Data Center ver. 7.0.0 - 9.10.1

You can connect your Zephyr instance to multiple Jira instances, if needed. Each Zephyr project works with one Jira project only.

How it works for users

Users can assign Jira tickets to Zephyr items and view assignments on Zephyr’s Defect Tracking screen:

For information on this, see Defect Tracking in the User Guide.

Set up Jira integration

This is a multi-step process that varies depending on the authentication type you use to connect to Jira. See the following page for complete information:

Setting up Jira Integration

Tip: To connect to Jira, you can use either OAuth or Basic authentication (the latter is also called cookie-based in Zephyr UI). Basic authentication is easier to configure, but OAuth is more secure. We’d recommend using OAuth connections, where possible.

Jira Integration screen

In Zephyr, you create, view, edit and delete Jira connections in the Administration > (System Setup) Jira Integration screen:

To create a connection, click at the top of the list and follow the instructions you see on screen. Depending on the connection type you choose, you may need to configure your Jira instance beforehand. See Setting up Jira Integration.

You can apply one of the following actions to a connection in the list:

Action	Description

Action	Description
	Invokes a dialog box where you can configure Zephyr-side connection settings. The dialog is different for OAuth and Basic authentication connections.
	Tests the connection.
	Deletes the connection.

Notes on integration

Webhooks

If you choose OAuth connection to Jira, Zephyr creates a pre-configured webhook on the Jira side.

Click Update webhooks on the Jira connections screen to update existing webhooks in all connected Jira instances, and to remove those webhooks that are not needed.

Jira Project Key Changes
Currently changing the Jira project key after JIRA requirements/defects & Zephyr test case mapping is not supported.
Before performing such changes, please contact Zephyr Support.

Custom fields of Jira items

Jira items can have user-defined (or custom) fields of various types: single-line and multiline text boxes, single-choice and multi-choice lists, radio buttons, labels, user pickers, URL fields, date pickers, and many others.

Zephyr supports these fields, that is, users can view and update these fields' values directly from the Zephyr UI.

To streamline operations, it may cache some field values (see below). You might need to update the cache manually.

Caching Jira data

Zephyr caches some Jira data to speed up user operations. It updates the cache at regular time intervals, but you might need to do this manually in the Defect Admin screen. See Caching Jira Data for details.

Settings

See Jira Management Preferences.

Alternatives

A possible alternative to Jira is using Zephyr’s built-in defect tracker. See Defect Tracking.

Zephyr Enterprise 8.1.0