JIRA integration

This guide walks through the process of setting up the Jira integration with our platform. The integration allows Sue to intake questionnaires on issues, add comments to issues, and update statuses.

Prerequisites

  • Admin access to your Jira instance, so you can install our Forge app.
  • Access to your organization's preferences in our platform

Installation Steps

1. Install the App

Note: For initial preview users, you'll receive an installation link. Once available in the Marketplace, the app can be installed directly from there.

  1. Click the installation link provided
  2. Follow the Jira permission screen to authorize the installation.
    Example Authorization Screen
  3. Wait for confirmation

2. Configure API Connection

  1. Navigate to the Jira app management page
    Jira App Management Screen
  2. Navigate to the Jira app configuration screen
    Conveyor Configure in Jira
  3. Go to your organization preferences in our platform
  4. Add a new integration:
    • Select "Converor API" from the integrations list
    • Enter a name for the key, like "Jira Service Desk"
    • Click "Save"
    • Click "Show" to reveal the API key
    • Copy the displayed API key
  1. Return to the Jira app configuration
  2. Paste the API key into the API key field
  3. Click "Save API Key"

The system will automatically:

  • Identify your Jira instance
  • Configure necessary connections

3. Project Selection

Since Jira is often used across multiple teams, you can selectively choose which projects to sync:

  1. Locate the project search box in the configuration
  2. Search for your desired project(s)
  3. Select the projects you want to integrate
  4. Save your selection

Troubleshooting

If you encounter any issues:

  • Verify your API key is correctly entered
  • Ensure selected projects are still accessible
  • Check for any error messages in the configuration panel

Support

For additional assistance or to report issues, please contact our support team.