Jira Setup Guide

Follow our setup guide to connect Jira to Fivetran. Fivetran supports both Jira On-Premises and Jira Cloud.

Prerequisites

To connect your Jira account to Fivetran, you need:

Your Jira host name
Your Jira port number

The Jira user account that you use to connect must have the following permissions:

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.

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	Learn more in Jira's Managing Project Permissions documentation.
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.

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

Setup instructions

Configure Jira for authentication

Follow the configuration instructions for your chosen authentication method.

Basic

How you set up Basic authentication depends on which type of Jira installation you have.

Jira On-Premises
1. In the Fivetran connection setup form, set the Authentication Type to Basic.
2. Enter your User name and Password.
Jira Cloud
1. In the Fivetran connection setup form, set the Authentication Type to Basic.
2. In your Atlassian account, create a basic API token by clicking Create API token.
3. In the User field, enter the email address for the Atlassian account you used to create the API token.
4. Enter the API token in the Password field.

OAuth

In the Fivetran connection setup form, set the Authentication Type to OAuth.
In the Consumer Key field, enter a unique key of your choice, or leave the default "OauthKey" if it's not already used by another external application in your Jira instance.
Make a note of the public key. You'll need it to create an application link in Jira.
Learn more about application links in the Jira Cloud or Jira Server documentation.
Log in to your Atlassian account.
In Jira, go to Jira Settings > Products > Integrations > Application Links.
Click Create link.
Click Direct application link in the Link type section of the Create link pop-up window.
In the Application URL section, enter https://fivetran.com, then click Continue.
A warning message will appear: "No response was received from the URL you entered." This is expected, as noted in Jira's documentation. Click Continue.
In the Link applications window, fill in the fields as follows:
- Application Name: Fivetran
- Application Type: Generic Application.
- Leave all other fields as shown (they're not functionally required by Fivetran).
- Check Create incoming link.
Click Continue.
In the next Link applications window, fill in the fields as follows:
- Consumer Key: The consumer key you specified in the Fivetran connection setup form (default "OauthKey").
- Consumer Name: Fivetran.
- Public Key: Paste the public key from your Fivetran connection setup form.
Click Continue. You should see a confirmation message: "Application Link 'Fivetran' created successfully".
Return to your Fivetran dashboard.
Click Authorize to complete the connection.
If you see an error like oauth_problem=XXXXX, refer to Atlassian's OAuth Troubleshooting Guide.

(Optional) Register webhook manually

If the Jira user account you use to connect doesn't have the Administer Jira global permission but you still want to capture deleted entities, you must register the webhook manually:

In the Fivetran connection setup form, set the Customer Created Webhook toggle to ON.
Copy the Webhook URL displayed. You'll need it when creating a new webhook in Jira.
The steps below are based on the instructions from Jira's webhook registration documentation.
Log in to your Jira instance as a user with the Administer Jira global permission.
Go to Jira Settings > System.
Under Advanced, select WebHooks.
Click + Create a WebHook.
In the Name field, enter a descriptive name such as _fivetran_custom_webhook_.
Select the Status to Enabled.
In the URL field, paste the webhook URL copied from the Fivetran connector setup form.
In the Issue related events section, select deleted event in the Issue column.
In the Project related events section, select the delete event in the Project column.
In the Jira Software related events section, select the created, deleted, and updated events in the Sprint column.
Click Create.

Finish Fivetran configuration

Follow the configuration instructions for your Jira installation type.

Jira On-Premises

In the connection setup form, enter the Destination schema name of your choice. This is used as the connection name and cannot be modified once the connection is created.
Enter your Jira Host (without http, https, or www).
Enter your Port number.
Set the On Premise toggle to ON.
In the Path (optional) field, enter your deployment path (for example, enter jira if your URL is your-company.com/jira). Otherwise, leave it blank.
Choose the issue sync mode: From all projects or From selected projects.
- If you choose From selected projects, select the projects whose issues you want to sync.
Click Save & Test. Fivetran will verify the connection and begin syncing your Jira data.

Jira Cloud

In the connection setup form, enter the Destination schema name of your choice. This is used as the connection name and cannot be modified once the connection is created.
Enter your Jira Host (for example, your-company.atlassian.net, without http, https, or www).
Enter your Port number.
The default port for Jira Cloud is 443.
Choose the issue sync mode: From all projects or From selected projects.
- If you choose From selected projects, select the projects whose issues you want to sync.
Click Save & Test. Fivetran will verify the connection and begin syncing your Jira data.

Connector Overview

Schema Information

Release Notes

API Connection Configuration