Jira Setup Guide

Fivetran supports both Jira On-Premises and Jira Cloud. How we connect to Jira depends on which Jira installation you have. Select the setup guide for your Jira installation:

• Jira On-Premises
• Jira Cloud

Prerequisites

To connect your Jira account to Fivetran, you need:

• Your Jira host name

• Your port number

• A connecting user with the permissions* listed in the following table:

  Entities	Roles and Permissions	Notes
  Projects Issues Related entities like versions, components, and boards	Administer Projects or Browse Projects permission	Learn more in Jira's Managing Project Permissions documentation.
  Project roles Project role actors	Administer Projects permission
  Users Groups	Browse users and groups global permission	Learn more in Jira's Managing Global Permissions documentation.
  Entities related to Jira Service Management (formerly Jira Service Desk)	Administrators or Service Desk Team project role	Learn more in Jira's Service Management permissions documentation.
  Permission and issue security schemes Related entities Webhooks (for registration)	Administer Jira global permission	Administer Jira global permission is also required to be able to register webhooks for capturing deleted entities like issues and projects. Learn more in Jira's Managing Global Permissions documentation.

  *NOTE: If you are missing any of the listed permissions, Fivetran does not sync the corresponding entities. Learn how permissions work in Jira's permissions documentation.

• To use OAuth - create an application link (see the Jira Cloud or Jira Server documentation) with the following details:

  • Application URL: https://fivetran.com
  • Consumer key: Use the consumer key specified in the Jira setup form
  • Public key: Use the public key mentioned in the Jira setup form

• To use Basic authentification:

  • For Jira On-Premises - your username and password
  • For Jira Cloud - create an API token for you Atlassian account

IMPORTANT: Only use an HTTPS URL with TLS version 1.2 or above.

Jira On-Premises Setup Instructions

1. In the connector setup form, enter the Destination schema name of your choice.

2. Enter the name of your Jira Host.

3. Enter your Port number.

4. Set the On Premise toggle to ON.

5. Enter the Path. If your deployment path looks like your-company.com/jira, then enter jira. Otherwise, leave the field blank.

6. Choose the Authentication Type:

   • If you choose Basic, provide your username and password

   • If you choose OAuth, perform the following steps:

     i. Configure the Application Link.

     ii. Click Authorize and allow Fivetran to access your data.

     NOTE: Refer to Atlassian's OAuth Troubleshooting Guide if you see the "oauth_problem=XXXXX" error when you click Authorize.

7. Choose the issue sync mode: From all projects or From selected projects.

8. If you choose From selected projects, select the projects whose associated issues you’d like to sync.

9. If you don't grant the Administer Jira global permission to the connecting user, but would like to capture deleted entities, follow the instructions in the Register webhook manually section.

10. Click Save & Test. Fivetran will take it from here and sync your data from your Jira account.

Jira Cloud Setup Instructions

1. In the connector setup form, enter the Destination schema name of your choice.

2. Enter the name of your Jira Host.

3. Enter your Port number.

   NOTE: The port number for Jira cloud is 443.

4. Choose the Authentication Type:

   • If you choose Basic:

     i. Create an API token

     ii. In the User field, enter the email address for the Atlassian account you've used to create the token.

     iii. Use the created API token as a Password

   • If you choose OAuth:

     i. Configure the Application Link

     ii. Click Authorize and allow Fivetran to access your data

     NOTE: Refer to Atlassian's OAuth Troubleshooting Guide if you see the "oauth_problem=XXXXX" error when you click Authorize.

5. Choose the issue sync mode: From all projects or From selected projects.

6. If you choose From selected projects, select the projects whose associated issues you’d like to sync.

7. If you don't grant the Administer Jira global permission to the connecting user, but would like to capture deleted entities, follow the Register webhook manually section in our setup guide.

8. Click Save & Test. Fivetran will take it from here and sync your data from your Jira account.

Configure Atlassian application link

Begin Fivetran configuration

1. Specify the Consumer Key or leave the default one, "OauthKey", if it is not used by another external application in your Jira installation.

   

2. Find the public key and make a note of it. You will need it to configure Jira to connect with Fivetran.

   

Create Atlassian application link

1. Log in to your Atlassian profile.

2. Go to Jira Settings, then select Products.

3. Go to Integrations, then select Application Links.

4. Click Create link.

5. Click Direct application link under the Link type section of the Create link pop-up window.

6. Enter https://fivetran.com in the Application URL section of the Create link pop-up window.

7. Click Continue.

Configure application link for Fivetran

1. You will receive a warning that "No response was received from the URL you entered." This warning is expected, as noted in Jira's documentation. Disregard this warning and click Continue.

2. In the Link Applications window, enter "Fivetran" as the Application Name.

3. For Application Type, select Generic Application.

4. Fill in the rest of the fields as shown below. These other fields do not matter for the purposes of setting up our Jira connection. Fivetran only needs to retrieve data, so we can set up a one-way (incoming) link from the client to Jira.

   

5. Select the Create incoming link checkbox.

6. Click Continue.

7. In the next Link Applications window, enter the Consumer Key you've specified in the setup form (default "OauthKey").

8. Enter "Fivetran" as the Consumer Name.

9. Enter the public key you found in the Begin Fivetran Configuration.

   

10. Click Continue. If setting up the Application Link was a success, you'll be taken to a page with this notification:

    

11. Return to the tab with your Fivetran dashboard.

Register webhook manually

Begin Fivetran configuration

1. Set the Customer Created Webhook toggle to ON

2. Copy the Webhook URL shown. It will be needed on the next step.

   

Create new webhook

NOTE: The instructions in this step repeat the instructions in Jira's Registering a Webhook documentation.

1. Log in to your Jira instance as a user with the Administer Jira global permission.

2. Go to Jira Settings, then select System.

3. Go to Advanced, then select WebHooks.

4. Select + Create a WebHook.

5. Enter the Name e.g. fivetran_custom_webhook.

6. Select the Status enabled.

7. Enter the URL copied in the setup form in the Begin Fivetran Configuration step.

   

8. Select the Issue deleted event in the Issue related events section.

   

9. Select the Project deleted event in the Project related events section.

   

10. Select the Sprint created, deleted, updated events in the Jira Software related events section.

    

11. Click Create.

12. Return to the tab with your Fivetran dashboard.

Custom field feature request

Contact our Support Team if you don't see a custom field you'd like to sync listed in our Jira documentation.

NOTE: To add a new field, you must grant access and perform a full historical re-sync.

Related articles

description Connector Overview

account_tree Schema Information

assignment Release Notes

settings API Connector Configuration

home Documentation Home