Skip to main content
|

​
Overview

The Jira integration connects CodeRabbit to your Jira workspace, bringing issue context into every stage of development. Here’s what the integration enables:

Context enrichment

Pulls in Jira issue details so CodeRabbit understands why a change is being made

Requirement validation

Assesses whether code changes address the linked issue’s acceptance criteria

Issue planning

Generates step-by-step from Jira issues for coding agents and IDE copilots

Issue creation

Creates new Jira issues directly from PR review comments

​
Prerequisites

Before setting up the Jira integration, ensure you have:
  • A Jira Cloud account (for Jira Data Center or self-hosted, see Jira Data Center below)
  • Admin access to install apps on your Jira site
  • A CodeRabbit Pro plan

​
Install the Jira Cloud integration

The Jira Cloud integration uses a Forge app from the Atlassian Marketplace. Follow these steps to connect your Jira site to CodeRabbit:
1

Enable Jira integration in CodeRabbit

Navigate to Integrations in the CodeRabbit app and toggle Jira to enable the integration.
2

Copy the installation secret

A modal appears with setup instructions and an Installation Secret (valid for 15 minutes). Copy the secret, then click Open Atlassian Installation.
3

Install from Atlassian Marketplace

On the Atlassian Marketplace page for the CodeRabbit app, click Get app.
4

Select your Jira site

Choose which Jira site to install the CodeRabbit app on and click Install.
5

Open Jira app settings

In your Jira site, click the Settings gear icon and select Marketplace apps.
6

Complete the setup

Under Apps, select CodeRabbit. On the CodeRabbit Setup page, paste the Installation Secret you copied earlier and click Complete Setup.
7

Verify the integration

Return to CodeRabbit and click Refresh Status to confirm the integration is connected.
The Installation Secret expires after 15 minutes. If it expires before you complete the setup, start the process again from step 1.

​
Jira Data Center (Self-Hosted)

​
Authentication and permissions

Jira Data Center uses a personal access token (PAT) with its REST API v2 client. The PAT does not use OAuth-style selectable scopes; it inherits the permissions of the Jira user who issues it. Use a dedicated CodeRabbit service account so you can scope and audit its access independently. Grant the integration user these permissions:
  • Access tickets and manage webhooks (required): Grant read and search access to every project and issue CodeRabbit should use, including issue details, comments, and attachments. The user must also be able to manage webhooks. During setup, CodeRabbit checks the Jira server and registers its webhook; the connection cannot be saved if Jira rejects the webhook registration.
  • Create issues (recommended): Grant issue-creation permission only if you want users to create Jira issues through CodeRabbit.
  • Add comments (recommended): Grant comment-creation permission for Jira-triggered Issue Planner acknowledgments, errors, and plan-ready replies.
  • Update comments (recommended): Grant permission to update comments created by the integration user so CodeRabbit can update its Jira response comment.
The webhook subscribes to issue-created, issue-updated, comment-created, comment-updated, and comment-deleted events. Jira 9 uses the older webhook API and subscribes only to issue-created and issue-updated events.

​
Network access

Your Jira Data Center instance must allow inbound HTTPS connections from CodeRabbit’s outbound IP addresses. If your Jira Data Center instance requires IP allowlisting, add these CodeRabbit IP addresses:
IPs to allow list

​
Integration behavior

​
Configure CodeRabbit for Jira

After connecting Jira, use project_keys to allow specific Jira projects and excluded_project_keys as the deny override. The project key is the prefix that appears before issue numbers—for example, if your issue URL is https://company.atlassian.net/browse/PROJ-123, the project key is PROJ. Excluded project keys are never used as CodeRabbit context, regardless of repository allowlists. Exclusions are managed as a workspace-level security policy and always take precedence over project_keys.
Add the project_keys setting under knowledge_base.jira in your .coderabbit.yaml file:
.coderabbit.yaml
The usage setting controls when the integration is active:
  • auto (default): Disabled for public repositories, enabled for private repositories
  • enabled: Always enabled
  • disabled: Always disabled
By default, Jira integration is enabled for private repositories and disabled for public repositories. You can override this behavior by setting knowledge_base.jira.usage: enabled and chat.integrations.jira.usage: enabled in your .coderabbit.yaml file or using the web interface. See the Configuration reference for details.

​
Example usage

​
Linking Jira issues to pull requests

To have CodeRabbit validate requirements from a Jira issue, include the issue URL in your pull request description:
CodeRabbit will fetch the issue details and assess whether your code changes address the requirements specified in the issue. See the Linked issues guide for best practices on linking issues.

​
Creating Jira issues from reviews

During a code review, you can ask CodeRabbit to create a Jira issue by mentioning @coderabbitai in a comment:
CodeRabbit will create a well-structured issue with relevant context from the code review discussion. See the Issue creation guide for more details.

Requirement validation

Best practices for linking issues to pull requests

Issue Planning

Generate Coding Plans from issues for coding agents

Issue creation

Create issues directly from CodeRabbit reviews