# Jira Workflow Connector

## **Overview**

The Workflow Connector integrates Relyance AI with Jira, enabling collaboration and automatic syncing of workflows across both platforms. This ensures that assessments, tasks, and insights stay in sync, reducing manual updates and potential miscommunication across teams. By pushing Relyance AI workflows into Jira, users can work faster and more efficiently while meeting other teams in the tools they already use, like Jira.

Follow these steps to set up the integration.

### **Navigate to Workflow Connectors**

![Screenshot](https://assets.relyanceuat.xyz/images/docs/31634732546701/31634755314573.png)
Go to **Settings** in Relyance AI and select **Workflow Connectors** from the left-hand menu.

### **Select Jira**

Locate the **Jira** integration in the **Workflow Connectors** page, marked with the Jira logo and description. You can also view the number of existing Jira connections.

### **Configure the Connection**

![Screenshot](https://assets.relyanceuat.xyz/images/docs/31634732546701/31634732534157.png)
Click the **Jira** tile to open the list of connectors. Each connector shows its **Connection Status** (e.g., Connected, Disabled).

#### **Add a New Jira Connector**

Click **Add Workflow Connector** in the top-right corner, enter a name for the connector (e.g., "Jira Connector 6"), and click **OK**.

#### **Authentication**

![Screenshot](https://assets.relyanceuat.xyz/images/docs/31634732546701/31634732534925.png)
Choose an authentication method. We currently support OAuth2. Enter the **Jira subdomain** and click **Authenticate**. This step ensures secure communication between Relyance AI and Jira.

#### **Insights Configuration**

1. **Select Project**: Choose the Jira project where insights will be pushed.
2. **Select Project Issue Type**: Set the default issue type (e.g., "Story").
3. **Automatically Push Insights**: Enable the toggle if you want to push insights of a specific type automatically.
4. **Field Mapping and Sync Configuration**: Map fields between Relyance AI and Jira, choosing **One-way** or **Two-way** sync. Add mappings as needed for various fields and statuses.

**Note:** Currently, only the following fields are supported for syncing between Relyance AI and Jira:

- Title
- Description
- Comments
- Status

#### **Assessment Configuration**

1. **Select Project**: Choose the Jira project where assessments will be synced.
2. **Select Project Issue Type**: Set the default issue type for assessments (e.g., "Task"). Note that if assessments are pushed to Jira as an "Epic," associated tasks will automatically become sub-tickets under that assessment.
3. **Automatically Push Assessments**: Toggle to enable automatic pushing of assessments of a specific type, if desired.
4. **Field Mapping and Sync Configuration**: Map Relyance fields to Jira fields. Configure synchronization for **One-way** or **Two-way** sync to ensure data flows correctly in both directions.

**Note:** Currently, only the following fields are supported for syncing between Relyance AI and Jira:

- Title
- Assessment Responses (only a one way sync)
- Status

#### **Webhook Configuration**

If **Two-way sync** is enabled for any field, you need to set up a webhook in Jira. Use the provided **Webhook URL** and **Webhook Secret** to register the webhook. The secret ensures secure transmission between the systems. Save the webhook secret securely, as it will not be displayed again.

#### **Completion**

Review the connection details, including:

- **Name** and **Description**
- **Authentication Type**
- **Configured Mappings** for insights and assessments

Ensure the **Connection Status** shows as "Connected." Click **Finish** to complete the integration.

### **Next Steps**

Once the connector is configured, continue to [Pushing Insights to Jira](https://docs.google.com/document/d/1qoPajRlrXV44yTN0ZAtySGUpCKSgQyW7cZbOaOq4nuI/edit#heading=h.98i5z3luf2xr) and [Pushing Assessments to Jira](https://docs.google.com/document/d/1qoPajRlrXV44yTN0ZAtySGUpCKSgQyW7cZbOaOq4nuI/edit#heading=h.lxwdka9kez5f) to make the most of your integration.

## **Pushing Insights to Jira**

The Workflow Connector allows you to push insights from Relyance AI into Jira, making collaboration and task tracking more efficient across both systems. Here’s how to manually push insights to Jira when the integration is configured.

![Screenshot](https://assets.relyanceuat.xyz/images/docs/31634732546701/31634755319309.png)

### **Prerequisites**

Ensure the Jira Connector is set up and configured correctly in Relyance AI. If automatic pushing is not enabled, insights need to be pushed manually.

### **Insight Configuration**

When configuring your Jira connection, you can choose between One-way and Two-way sync:

- One-way sync: This setup pushes data from Relyance AI to Jira. Changes made in Jira will not be reflected in Relyance AI. This is useful when Jira is solely used for task tracking, and Relyance AI is the primary source of truth.
- Two-way sync: With this setup, data is synchronized between both platforms. Changes made in Jira, such as status updates or comments, will automatically sync back to Relyance AI, and vice versa. This is ideal if teams use both systems to manage tasks and need updates reflected in real time.

Note: Currently, only the following fields are supported for syncing: Title, Description, Comments, and Status.

### **How to Push Insights to Jira**

1. Navigate to the Risks & Insights Screen: In Relyance AI, go to Risks & Insights under the Take Action section. This will show you a list of identified risks and insights.
2. Select an Insight: Choose the specific insight you want to push to Jira. This will open a detailed view of the insight on the right-hand side of the screen.
3. Push the Insight to Jira: In the detailed view, you’ll see a Push to Jira button. Click it to begin pushing the insight to Jira.
4. Select the Jira Connection: After clicking the button, a modal will appear asking you to select a Jira connection from a dropdown list. Select the appropriate connection and click Push to confirm.
5. Verify in Jira: The insight will now appear as a new issue in the selected Jira project. It will include the insight’s title, status, priority, assignee, due date, description, and relevant tags.

### **Additional Information**

If your Jira integration is configured to automatically push certain types of insights, the manual step will not be needed. Additionally, if Two-way sync is enabled, any status changes made in Jira (e.g., from "Open" to "In Progress") will automatically update the insight's status in Relyance AI.

**Pushing Assessments to Jira**

With the Relyance AI and Jira integration, you can push assessments directly into Jira to ensure tasks related to assessments are tracked effectively. This is especially useful for collaborating with other teams who primarily use Jira to manage their workflows. Here's how to manually push an assessment to Jira.

![Screenshot](https://assets.relyanceuat.xyz/images/docs/31634732546701/31634732540557.png)

### **Prerequisites**

Ensure the **Jira Connector** is set up and properly configured in Relyance AI. If automatic pushing is not enabled, assessments must be manually pushed.

### **Assessment Configuration**

When setting up the Jira connection, you can configure **One-way** or **Two-way sync** for assessments:

- **One-way sync**: Changes made in Relyance AI will be pushed to Jira, but updates made in Jira won’t reflect back in Relyance AI. This setup is best if Relyance AI remains the primary source of truth for assessments.
- **Two-way sync**: Changes in both Jira and Relyance AI will sync in real-time. If an assessment’s status or title updates in Jira, it will automatically update in Relyance AI, and vice versa. This ensures that teams using both systems are always in sync.

**Note:** Currently, only **Title, Responses, and Status** are supported fields for syncing.

### **How to Push Assessments to Jira**

1. **Navigate to the Assessment:** Go to the **Assessments** section in Relyance AI and select the specific assessment you want to push to Jira.
2. **Access Assessment Details:** In the assessment view, click the **Assessment Details** button in the upper right-hand corner of the screen.
3. **Push the Assessment to Jira:** After opening the details panel, click the **Push to Jira** button to initiate the process of pushing the assessment to Jira.
4. **Select a Jira Connection:** A modal will appear, prompting you to choose the Jira connection where the assessment will be pushed. Select the appropriate connection from the dropdown list and click **Push** to confirm.
5. **Confirm in Jira:** Once pushed, the assessment will appear as a new issue in the selected Jira project, with all relevant details transferred from Relyance AI. These include:
    - **Title** of the assessment
    - **Responses** of the assessment are displayed in the description field of the Jira ticket.
    - **Status** to reflect its progress (e.g., "Open", "In Progress")

### **Additional Information**

If **Automatic Pushing** is enabled for assessments, you won’t need to manually push each assessment. Additionally, if **Two-way sync** is configured, any changes made to the assessment in Jira will reflect back in Relyance AI.
