API Integration

Overview

The Jira API integration lets you connect a TestKase project to your Jira instance so you can search Jira issues, link them to your test cases, and keep a lightweight traceability bridge between test management and issue tracking. When you link a test case to a Jira issue, TestKase posts a comment on that issue listing the linked test cases, so Jira users can see test coverage without leaving Jira. Issue status is pulled from Jira on demand whenever you refresh it.

Prerequisites

Before setting up the Jira integration, make sure you have the following ready:

For Jira Cloud

1. An active Jira Cloud account with a project containing issues.
2. An API token generated from your Atlassian account.
3. Your Jira email address (used alongside the API token for authentication).
4. The instance URL of your Jira site (e.g., https://your-org.atlassian.net).

For Jira Server / Data Center

1. Your Jira Server or Data Center base URL (e.g., https://jira.yourcompany.com).
2. A Personal Access Token (PAT) from your Jira profile settings.
3. The PAT must have read and write permissions on the target project.

TestKase Permissions

You must have Project Admin or Owner role in the TestKase project to configure integrations. See User Permissions for details.

Setup

In TestKase project settings, requirement and defect integrations are configured separately. To search and link Jira issues from your test cases, configure the requirement integration:

1. Open your TestKase project Settings and go to the requirement integration configuration.
2. You will see the integration setup card. Click Configure.
3. Select Jira as your platform.
4. Enter your Instance URL:
   • Jira Cloud: https://your-org.atlassian.net
   • Jira Server: https://jira.yourcompany.com
5. Enter your Email address (Jira Cloud only -- this is the email associated with the API token).
6. Paste your API Token (Jira Cloud) or Personal Access Token (Jira Server).
7. Click Connect. TestKase validates the credentials and fetches your Jira projects.
8. Select the Jira project you want to link to this TestKase project.
9. Click Save to complete the connection.

Linking Requirements

Once connected, you can search your Jira project's issues from within TestKase and link them to test cases as requirements. There is no automatic bulk import and no continuous background sync -- issues are searched on demand and linked individually.

How Linking Works

• Search on demand -- From a test case, search your connected Jira project's issues by keyword. TestKase queries Jira live and returns matching issues (key, summary, and status).
• Link an issue -- Select an issue to link it. The Jira issue summary is stored as the requirement title and the Jira issue key (e.g., PROJ-123) is stored as a clickable reference.
• Coverage comment -- When you link a test case to a Jira issue, TestKase posts a comment on that issue listing the linked test cases. Linking or unlinking additional test cases updates or removes that comment. This is the only change TestKase writes back to Jira.

Linked Requirement Behavior

• Linked requirements display a Jira badge showing the issue key. Clicking the badge opens the Jira issue in a new tab.
• Jira remains the source of truth for the linked issue's title and status.
• You can link test cases and defects, add attachments, and assign requirements to folders within TestKase -- these fields are managed locally.

Traceability from Test Cases

From the test case detail view, you can link test cases to Jira issues. This creates a traceable connection between your Jira backlog and your test suite.

When a test case is linked to a Jira issue, TestKase automatically posts a comment on the corresponding Jira issue showing the linked test case details. This gives Jira users direct visibility into which tests cover each issue -- without leaving Jira. Unlinking a test case updates or removes that comment accordingly.

Refreshing Issue Status

TestKase does not receive live webhooks or run a background sync. Instead, the status of a linked Jira issue is refreshed on demand:

• Use the refresh action to pull the current status of a linked issue from Jira into TestKase.
• The raw status value from Jira is stored as-is. There is no automated transformation of Jira statuses or priorities into TestKase values.
• Refresh whenever you want the latest status -- for example, before reviewing coverage or building a report.

Defect Push

When available, defect push is planned to create a new Jira issue from a TestKase defect, establish a cross-reference link between the two, and map defect priority and status to the corresponding Jira fields. This capability is not yet built.

Management

Edit Connection

To update your integration settings (project or credentials):

1. Open the requirement integration (or defect integration) configuration in project settings.
2. Click Edit on the integration card.
3. Modify the fields you want to update (e.g., update the access token).
4. Click Save to apply changes.

Disconnect (Reset)

To completely remove the integration:

1. Click Reset on the integration card.
2. Confirm the disconnection.

What happens when you disconnect:

• Issue search and status refresh stop working for this project.
• Existing linked requirements are preserved in TestKase -- they are not deleted.
• Cross-reference badges on existing items continue to link to the Jira URL.
• Comments already posted on Jira issues remain in Jira.
• You can reconnect to the same or a different project at any time.

Troubleshooting

▶I see an 'Authentication failed' error

This usually means your access token is invalid or expired. Steps to resolve:

1. Verify the token is still valid in your Jira account settings.
2. For Jira Cloud, ensure you are using the correct email address (the one associated with the API token).
3. For Jira Server, confirm the PAT has not been revoked by an administrator.
4. Generate a new token and update the integration in TestKase.

▶I can't see my Jira project in the dropdown

Your access token may not have access to that project. Common causes:

• The token user does not have permission to access that Jira project.
• The project is archived or deleted in Jira.
• For Jira Cloud, the token scope may be limited. Create a new token with full project access.

▶A linked issue's status looks out of date

TestKase does not sync status in the background. Use the refresh action on the linked issue to pull its current status from Jira. If refresh fails, verify the integration is still connected and the access token has not expired.

▶The coverage comment did not appear on my Jira issue

TestKase posts a comment on the Jira issue when you link a test case to it. If the comment is missing:

• Confirm the token user has permission to add comments to that Jira project.
• Confirm the integration is still connected and the token has not expired.

▶Can I connect multiple Jira projects to one TestKase project?

No. Each TestKase project supports one external integration connection at a time (per integration type). To work with multiple Jira projects, create separate TestKase projects for each. This keeps the traceability clean and avoids cross-project confusion.

▶What happens to linked requirements if I disconnect?

Linked requirements remain in TestKase as regular requirements. The Jira badge continues to link to the Jira URL, and no further status refresh is possible until you reconnect. No data is lost during disconnection.

▶Can I use the same Jira token for multiple TestKase projects?

Yes. The same Jira API token can be used across multiple TestKase projects. Each project connects to a different Jira project using the same token, as long as the token user has access to all the Jira projects.

▶Is Jira Service Management supported?

Jira Service Management projects can be searched and linked as long as the token user has access to them. Service request-specific fields are not mapped.

Next Steps