Knowledge Base

Jira Integration

This document outlines how to integrate our platform with Atlassian Jira, enabling powerful workflows for issue tracking, project management, and development collaboration.

Benefits of Jira Integration

• Automated Issue Creation: Automatically create Jira issues from platform events.
• Real-time Sync: Keep your Jira tickets and platform data synchronized.
• Enhanced Visibility: Track project progress and issues directly within Jira.
• Streamlined Workflows: Connect your development lifecycle with issue management.

Prerequisites

• A valid Jira Cloud or Jira Server instance.
• Admin privileges in your Jira instance.
• An API token or username/password for Jira authentication.

Setup Guide

Step 1: Obtain Jira API Credentials

To authenticate with Jira, you'll need an API token or your Jira username and password.

1. Log in to your Jira account.
2. Navigate to your Atlassian account settings.
3. Under "Security", find "API tokens" and click "Create API token".
4. Give your token a descriptive label (e.g., "Platform Integration") and click "Create".
5. Copy the generated token immediately. You won't be able to see it again. Store it securely.

For Jira Server, you might use username and password, but API tokens are recommended if available.

Step 2: Configure Integration in Our Platform

Follow these steps within your platform dashboard:

1. Go to the "Integrations" section.
2. Select "Jira" from the list of available integrations.
3. Click "Add New Integration".
4. Enter your Jira instance URL (e.g., https://your-company.atlassian.net).
5. Choose your authentication method: "API Token" or "Username/Password".
6. If using "API Token", enter your Jira email address and the API token you generated.
7. If using "Username/Password", enter your Jira username and password.
8. Click "Connect Jira".

Step 3: Map Projects and Issue Types

Once connected, you can configure specific mappings:

1. Select the Jira project you want to integrate with.
2. Choose the default Jira issue type (e.g., "Task", "Bug", "Story") for new issues created from our platform.
3. Optionally, configure field mappings for custom fields you want to populate.
4. Define trigger conditions for creating Jira issues (e.g., when a specific event occurs).

Example Workflow

Let's say you want to automatically create a Jira 'Bug' ticket whenever a critical error is logged in our platform:

1. In the Jira integration settings, select your Jira project.
2. Set the default issue type to 'Bug'.
3. Under "Triggers", select "Critical Error Logged".
4. Map the "Error Message" from our platform to the "Description" field in Jira.
5. Map the "Severity" to a custom "Priority" field in Jira if applicable.

Now, every critical error will automatically generate a corresponding bug report in Jira, streamlining your debugging process.

Troubleshooting

• Connection Errors: Double-check your Jira URL, API token/credentials, and ensure network connectivity to your Jira instance.
• Permission Issues: Verify that the API token or user account has the necessary permissions in Jira to create issues and access required projects.
• Mapping Errors: Ensure that custom field names in your mappings exactly match the field names in Jira.

For more advanced configurations or specific troubleshooting, please refer to our Support section or consult the official Jira API documentation.

View All Integrations