Get Started

Jira

An overview of the Jira integration with Secoda

Jira Metadata Extracted

You might consider integrating your Secoda workspace with Jira if your team receives data requests through Jira.

Getting Started with Jira

There are three steps to getting started using Jira with Secoda

  1. Create an Jira project to upload your issues, or locate an existing project

  2. Prepare your Jira credentials

  3. Connect Jira to Secoda

Create a Jira Project

Note: if you have an existing project that you would like to connect, skip this step

Navigate to this url and login to or sign up for Jira with the same email used for Secoda. Navigate to Jira Software and find the Projects tab. If you do not have one, create a new project with a name similar that of the Secoda team it will be connected to for easy management. This can be either a team-managed or company-managed project.

Once created or found, you should see the project with its respective boards and issues:

Prepare Your Jira Credentials

There are eight items you will need in order to integrate your Jira project into Secoda:

  1. Project URL

  2. Project name

  3. Project key

  4. Issues Filter (optional)

  5. Jira API token

  6. Account email

  7. Organization ID

  8. Organization Admin API key

Project URL

To find your project's URL, name, and key, remain on your project's main page.

Note the website URL. You will take the section of URL resembling https://your-domain.atlassian.net/ and enter it into the Project URL section of Secoda's Jira integration setup. In the example screenshot above, this URL would be https://secoda-elai.atlassian.net/.

Project Name and Key

The project name and key will also be found on this page. Click the Projects tab to see a list of your projects, and find the one that you would like to integrate with Secoda. The project name will be the full name, while the project key is the 2 or 3 letter string inside of the brackets beside your project name

In this example, the project name is Marketing, and the project key is MAR. Enter these values into Secoda's Jira integration setup.

Issues Filter (optional)

If you want to filter the issues that will be synced to Secoda, you can enter a custom JQL query. Go to the Filters tab and click on/create a new filter. Once you are satisfied with the filter, change the switch found in the top right from Basic to JQL. The JQL query will pop up in the header bar, and you can copy that in the setup.

Note: The project in the filter must be the same as the project you entered from above, or no issues will be synced.

API Token

Next, you must obtain an API token for Jira. Login to this page and click "Create API token". When prompted, name the token the same name as your project, copy and save it somewhere secure, as it cannot be accessed afterwards. Enter this token into the respective section on Secoda's Jira integration setup.

Note: multiple API tokens can link to the same Jira project

Account Email

To find your account email, you can click on the icon in the top right corner of any Jira page, and enter it into the Account Email section of Secoda's Jira integration setup.

Note: For Jira users to appear as assignees on Secoda, you can either get an organization admin key as seen below, or have users change email visibility to "Anyone" by going through Manage Account -> Profile and Visibility -> Contact

Organization ID

To find your organization ID, go to this link, and select the workspace that you want to import. Then, the page will redirect you to https://admin.atlassian.com/o/{your-org-id}/overview and you can copy the ID from the link.

Organization Admin API key

After you have logged into your organization on https://admin.atlassian.com/, head to the settings tab in the navbar. From here, click API keys on the left sidebar, and create a key with a label of your choosing. On creation, it will show you your organization ID as well as the API key.

Connect Jira to Secoda

  1. Open your Secoda integrations page

  2. Click on "New Integration" on the top left

  3. Select Jira from the list of integrations

  4. Input your Jira credentials from Prepare Your Jira Credentials above. This includes the project URL, name, key, issues filter, API token, your Jira email, organization ID, and organization admin API key

  5. Select the Teams that you wish to receive the Jira issues (appearing as Questions in Secoda)

  6. Click on "Test Connection" to save the integration

  7. Once integration is created, click on “Run Extraction” from history tab to run your first extraction

Once the Jira extraction finishes running, you will be able to view all issues from your Jira project in the desired team's Question page.

Last updated