Syncing conversations to my JIRA project

By connecting Workstream to your JIRA project, we will automatically create tasks in your backlog and sync status updates.

Nicholas Freund avatar
Written by Nicholas Freund
Updated over a week ago

Introduction

Using Workstream, you can now collaborate directly in line with your live data assets. This can start when a stakeholder makes request in the native UI of your business intelligence tool (via the Workstream Concierge), and then finish when a data team member responds via our web application.

With our JIRA integration, we will also automatically create a ticket in your JIRA backlog when a conversation is started in Workstream. This allows you to leverage our our in line collaboration functionality while still prioritizing customer requests and support alongside the rest of your data engineering and analytics work.

Please scroll to the bottom of this article to view a demo of the experience after JIRA is connected.

Step 1: Connect your JIRA Account

If possible, we recommend using a separate "service account" in JIRA. This helps us avoid service interruptions, and makes the connection easier to manage. Follow our walkthrough to learn how to create a service account.

If you are just trying out Workstream, feel free to use your personal JIRA account as you can always switch over to a service account later. You can follow the below instructions and/or the video at the bottom of this page.

Within Settings > Workspace Settings > Connections you will see a card for JIRA with a prompt to "Connect." Upon clicking, you will be asked for the below information.

  1. Email address. This is either your email address, or the service account being used to create the connection.

  2. API Token. You can create this in JIRA by:

    1. Clicking your Avatar and navigating to "Account Settings"

      Image showing how to access account settings in JIRA
    2. Navigating to "Security"

      Gif displaying how to manage access tokens in JIRA
    3. Clicking "Create and manage API tokens"

  3. JIRA Domain. This is the name of your JIRA instance, ending in .net/.

Image showing the required details for connecting your JIRA account

Step 2: Select your Project and Issue Type

After successfully connecting, you will be prompted to select a Project and an Issue type.

  • Project. The selected project will be the one in which Workstream will automatically create tickets when new conversations are created in Workstream.

  • Issue type: This is the JIRA issue type that we will create for you. You can select any of the issue types in the selected project.

    Image showing how to select a project and issue type for your JIRA integration in Workstream


Step 3: Map your inbound JIRA and Workstream statuses

In this step, you will need to indicate what should happen in Workstream when a status is changed natively in JIRA. On the left you will see all of the available statuses for the selected JIRA issue type, and on the right you will be prompted to map those to the relevant Worsktream statuses.


Image depicting an example mapping of inbound JIRA to Workstream statuses

Step 4: Finalize outbound status and finalize connection

In this final step, you will need to do two last things before:

  1. JIRA ticket creation: By default, the JIRA integration is configured to automatically create a JIRA ticket whenever a new conversation is created in Workstream. If you want to tweak that so that you have a bit more control over what ends up in your backlog, feel free to select another status to trigger ticket creation.

  2. Outbound status types: Finally, you will need to confirm what happens in JIRA when a conversation status is updated in Workstream. You will see Workstream statuses on the left, and on the right you will be prompted to map those to the right JIRA statuses.

    Image depicting an example mapping of outbound Workstream to JIRA statuses

When you are done, click "Connect" and your JIRA integration should be set up! Now anytime a conversation is created in Workstream, we will create a ticket for you and bi-directionally keep the statuses in sync.

⚙️ Please note: due to JIRA api limitations, status changes made to a ticket in JIRA will only sync back to Workstream every 30 minutes. Syncs from Workstream to JIRA, however, should be in near real time. Please reach out to us with any questions.

Did this answer your question?