# Jira On-Premise

This guide provides detailed instructions for integrating Jira with ReleaseOwl to streamline user story management and automation. After successful configuration, ReleaseOwl automatically fetches **Projects**, **Sprints**, and **User Stories** from your Jira instance based on the settings you define.

To enable continuous, real-time synchronization of User Stories, Jira must be configured with appropriate **Webhooks** or **Automation Rules**. These configurations ensure that ReleaseOwl receives updates instantly whenever changes occur in Jira.

### **1. Jira Environment & Connectivity Requirements**

Ensure that the following prerequisites are met before configuring the integration:

* **Jira URL is reachable** from ReleaseOwl
* **Basic Authentication** is enabled
* **REST API endpoints** are accessible
* If Jira uses an **IP Allowlist**, ensure ReleaseOwl’s IP/domain is added to the allowed list

### **2. Required Jira Global Permissions**

The Jira user account configured in ReleaseOwl must have the following permissions:

* **Browse Users**
* **Create Shared Objects** (optional, but recommended for shared filters and boards)

### **3. Register Jira On-Premise Credential ( Basic Authentication)**

Follow the steps below to register your Jira credentials in ReleaseOwl:

1. Go to  the ReleaseOwl Dashboard.
2. Navigate to **Administration**, then select **Credential Manager**.
3. Click on **Register Credential**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F6ed4nGxwD33JwOZEKZcS%2Fimage.png?alt=media&#x26;token=16f6d46e-fdba-486b-b389-4fbedad1a6ce" alt=""><figcaption></figcaption></figure>

4. Fill out the credential form with the following details:

* **Credential Name:** Enter a preferred name for this credential.
* **Credential Type:** Jira
* **Authentication Type:** Basic
* **Scope** – Select the scope of the credential:
  * **Global** – Visible to all users.
  * **Private** – Visible only to the user who created it.
* **Username:** Provide the username associated with the credential (e.g., Jira account)
* **Password/API Token**: Enter the password or API token for authentication with the chosen system.
* **Jira URL:** Paste your local or organization-specific Jira URL
* **Proxy Type:** None

5. Click **Save** to complete the credential registration.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FkXKmCvM7BEAHjDmZqpzm%2Fimage.png?alt=media&#x26;token=ebe114d7-faa7-4765-bbbe-b2cdd3921c9f" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note:** Do not paste the Bearer Token in the Password/API field under Basic Authentication, as it will not work. Always select **Bearer Token** as the authentication type.
{% endhint %}

### **4. Register Jira On-Premise Credential (OAuth Authentication)**

Follow the steps below to register your Jira credentials in ReleaseOwl:

1. Select **Applications** from the Jira administration menu.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F3kKw5HfKT2U1ayWFo984%2Fimage.png?alt=media&#x26;token=e5d77c20-bc32-4a05-acc3-70b5f25cdd06" alt=""><figcaption></figcaption></figure>

2. In the **Applications** section, click **Application Links**, then click **Create link**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FQnrU8MF3o4Wz7zLHWAV1%2Fimage.png?alt=media&#x26;token=59436c63-8e07-44e9-b2f4-e180ef6ed6f3" alt=""><figcaption></figcaption></figure>

3. For **Application type**, select **External Application**.
4. For **Direction**, select **Incoming**, and then click **Continue**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FPKZQqc9zek7KmQ3wlhaY%2Fimage.png?alt=media&#x26;token=d9cd8dee-d748-458e-ae0c-32f20cede899" alt=""><figcaption></figcaption></figure>

5. Under ***Application Permissions***, select only ***Admin*****&#x20;permissions**.
6. For the **Redirect URL**, enter: <https://na3.releaseowl.com/rateloginserver/api/jira/accesstoken>
7. Click **Save**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FhNZLntdkhxZLk9ZQSw6i%2Fimage.png?alt=media&#x26;token=5fed1fb7-45bf-4999-bd29-d8daca57a537" alt=""><figcaption></figcaption></figure>

8. After saving, copy the **Client ID** and **Client Secret** for use in ReleaseOwl.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F3gWiikxUm8HtEZaVGlXE%2Fimage.png?alt=media&#x26;token=3b09d137-4629-47f1-b326-bde1d827039c" alt=""><figcaption></figcaption></figure>

#### **Registering Jira in ReleaseOwl Dashboard**

To integrate Jira with ReleaseOwl for issue tracking and traceability, follow the steps below to register Jira credentials and set up project integration.

1. Go to  the ReleaseOwl Dashboard.
2. Navigate to **Administration**, then select **Credential Manager**.
3. Click on **Register Credential**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F4r7EvNYB34sRHrGFCcdx%2Fimage.png?alt=media&#x26;token=5fe3eec0-63fa-4509-a586-8ce6b841c931" alt=""><figcaption></figcaption></figure>

4. Fill out the credential form with the following details:

* **Credential Name:** Enter your preferred name for the credential.
* **Credential Type**: Jira
* **Authentication Type**: Select the authentication type as theOAuth2
* **Scope** – Select the scope of the credential:
  * **Global** – Visible to all users.
  * **Private** – Visible only to the user who created it.
* **Client ID and Client Secret:** Paste the Client ID and Client Secret obtained from the OAuth2 integration you created in the Atlassian Developer Console.
* **Jira URL**:  Paste your local or organization-specific Jira URL
* **Proxy Type**: Select None

5. Click **Save** to register the credential.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FwQxfzC5XkCFTIATNIoOz%2Fimage.png?alt=media&#x26;token=2832609d-e826-4481-bf78-17b2b1b2c2c1" alt=""><figcaption></figcaption></figure>

### **5. Register Jira On-Premise Credential ( Bearer Token)**

* Log in to your Jira account.
* Navigate to your **Profile** in Jira.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FZ9nd0LLDxi3e7W3WCfrz%2Fimage.png?alt=media&#x26;token=976989ed-1497-48ea-956d-7e95a78feaaf" alt=""><figcaption></figcaption></figure>

* Click on **Create Token**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F3rKl2i4zX7tIjZTj45rT%2Fimage.png?alt=media&#x26;token=aad30afd-2622-4771-9cc5-bec89f1794b4" alt=""><figcaption></figcaption></figure>

* Provide the required details (such as token name and expiration, if applicable).
* Click **Create** to generate the token.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FhaojEfZYZzmEQp2mEJq4%2Fimage.png?alt=media&#x26;token=7ae54e51-bbf5-4e43-ae32-ee920d1d0ded" alt=""><figcaption></figcaption></figure>

* Copy the generated **Bearer Token** for use in ReleaseOwl credential configuration

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FVLQFgcCMDZBzqqAtao61%2Fimage.png?alt=media&#x26;token=334ecdad-5fde-4e7d-a341-f72f175dd316" alt=""><figcaption></figcaption></figure>

#### Jira Bearer Token Integration with ReleaseOwl

To integrate Jira with ReleaseOwl for issue tracking and traceability, follow the steps below to register Jira credentials and set up project integration.

1. Go to  the ReleaseOwl Dashboard.
2. Navigate to **Administration**, then select **Credential Manager**.
3. Click on **Register Credential**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F4r7EvNYB34sRHrGFCcdx%2Fimage.png?alt=media&#x26;token=5fe3eec0-63fa-4509-a586-8ce6b841c931" alt=""><figcaption></figcaption></figure>

4. Fill out the credential form with the following details:

* **Credential Name:** Enter your preferred name for the credential.
* **Credential Type**: Jira
* **Authentication Type**: Select **Bearer Token**.
* **Scope** – Select the scope of the credential:
  * **Global** – Visible to all users.
  * **Private** – Visible only to the user who created it.
* **Token:** Paste the copied **Bearer Token**.&#x20;
* **Jira URL**:  Paste your local or organization-specific Jira URL
* **Proxy Type**: Select **None**

5. Click **Save** to register the credential.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FlE54UN3MJ46cmOFPiPDa%2Fimage.png?alt=media&#x26;token=be7c9a1b-a38f-4b86-8efb-c74a3a5738cf" alt=""><figcaption></figcaption></figure>

## **Jira Project Integration**

To link a Jira project with a ReleaseOwl project, follow the steps below:

### **1. Navigate to Project Settings**

* Switch to the required working project in ReleaseOwl.
* Go to **Project Settings**.
* In Project Settings, navigate to **ALM Integrations** and click **Add**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FTb6fx6ylJFnqcUEbbaXf%2Fimage.png?alt=media&#x26;token=e48cd40f-53d6-4018-a67e-446b5d08ed95" alt=""><figcaption></figcaption></figure>

### **2. Fill in the Required Details**

* **Name:** Enter a unique integration name.
* **Description:** (Optional) Add a relevant description.
* **External System:** Select Jira.
* **Credential:** Choose the registered Jira credential.
* **Host URL:** Jira Server URL (e.g., [*https://jira-dev.releaseowl.com/*](https://jira-dev.releaseowl.com/)).

### **3. Select Hosting Type**

* Choose **On-Premise** if your Jira runs on a private server.
* Choose **Cloud** if your Jira instance is hosted on Atlassian Cloud.

### **4. Select External Project**

* Choose the Jira project from the pop-up list.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FAT4e9p7DR8S9nhhhB7fy%2Fimage.png?alt=media&#x26;token=5cd20591-69b2-42b7-a827-bf043e413856" alt=""><figcaption></figcaption></figure>

#### **A. Using Boards**

* Select **Boards** to sync issues using a specific Jira board.
* **Board:** Choose the required Scrum or Kanban board.
* Click **Save**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FbTgxi18wMvehVVUEPAmA%2Fimage.png?alt=media&#x26;token=ab52e732-fed9-4efa-9814-ec0400997138" alt=""><figcaption></figcaption></figure>

Once saved, the integration appears in the list. If **Default Integration** is selected, it will be used by default.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FzkgjXdzA6CO6Ri9SBMHb%2Fimage.png?alt=media&#x26;token=f361281f-5f6e-467c-8faa-eda9b273963e" alt=""><figcaption></figcaption></figure>

#### **B. Using Filters**

* Select **Filters** to sync issues using Jira’s saved filters.
* All available filters that user has permission will be displayed.
* Choose the desired filter.
* Ensure the filter has proper permissions and is shared with required users.

#### **C. Using JQL (Jira Query Language)**

* Select **JQL** to fetch issues using advanced queries.
* Create a JQL query in Jira.
* Copy and paste the query into ReleaseOwl.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FH6zmVzkz6j2Gj1SCPbKD%2Fimage.png?alt=media&#x26;token=efb022fd-d9d2-4e6b-9d30-4b733cc6bbed" alt=""><figcaption></figcaption></figure>

### **Note**

* **Webhook URL:** Auto-generated by ReleaseOwl and used to capture and sync Jira events.
* **Webhook Request URL for Automation Rule:** Also auto-generated by ReleaseOwl.
* **Disable Writing of Comments/Notes:** An optional toggle that allows you to control whether comments or notes are automatically added.

## **Configuring the Webhook URL**

ReleaseOwl supports automatic synchronization of user story changes made in Jira through webhooks.

1. Log in to your Jira account.
2. Go to **Settings → System → WebHooks**.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F6elV79ETE3eikbM6vqT1%2Fimage.png?alt=media&#x26;token=77c89a5b-7c7f-45b1-817a-17ccd67b98e7" alt=""><figcaption></figcaption></figure>

3. Copy the Webhook URL generated in ReleaseOwl.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F9jK0sqxpeFso6ajuVyAV%2Fimage.png?alt=media&#x26;token=0c078ad0-fc7f-415f-81e2-e2913aee23e0" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F83iM2bsD05nE54PfqIBR%2Fimage.png?alt=media&#x26;token=bc417eee-4d12-4717-b686-856860cde9eb" alt=""><figcaption></figcaption></figure>

4. Paste it in the **URL** field on the Jira WebHook configuration page.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FMMnCkRnNTWH2wY8812WD%2Fimage.png?alt=media&#x26;token=4e22cb98-9b05-416c-81f4-d0d786905751" alt=""><figcaption></figcaption></figure>

5. In the events section, instead of all events it is recommended to add filter condition for Project.

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2F6Epq18wqtd7SwSBM1YU6%2Fimage.png?alt=media&#x26;token=7fa1d25e-3d99-4ca2-998d-f73226a92d40" alt=""><figcaption></figcaption></figure>

6. Select the issue-related events that you want to track for your project (e.g., story creation, updates, etc.).
7. After entering all the details, you can enable or disable the webhook in the status section.&#x20;

<figure><img src="https://1890383800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWyxe6hm5vqosFaByVgs%2Fuploads%2FBb4dg5PFkAD63eRsrzj2%2Fimage.png?alt=media&#x26;token=676a5efb-eb35-4571-99d6-9094bfcc9e24" alt=""><figcaption></figcaption></figure>
