Our JIRA integration is currently in Open Beta. As such, the info in this article may change.
Release Status | Open Beta | Availability | Premium |
Status Page | JIRA Status Page | Default Historical Sync | 1 year |
Whitelist Tables/Columns | Unsupported/Unsupported | Default Replication Frequency | 30 minutes |
Full Table Endpoints | 6 | Incremental Endpoints | 1 |
Destination Incompatibilities | None |
Connecting JIRA
Depending on your setup, connecting JIRA is a five or seven-step process:
- Whitelist Stitch’s IP Addresses
*
- Verify protocol support
*
- Retrieve the Stitch Public Key
- Grant Stitch application access to JIRA
- Add JIRA as a Stitch data source
- Define the Historical Sync
- Define the Replication Frequency
*
These steps only need to be completed if you’re using a self-hosted (on-site) version of JIRA.
Prerequisites
You must have Adminstrator permissions in JIRA. This is required to complete parts of the setup process.
Whitelisting Stitch’s IP Addresses
If your JIRA instance is both self-hosted AND behind a firewall, you’ll need to whitelist the Stitch IP addresses to successfully connect to Stitch. Whitelist all of the following IP addresses:
-
52.23.137.21/32
-
52.204.223.208/32
-
52.204.228.32/32
-
52.204.230.227/32
Be sure to do this before continuing through the rest of the setup or you may encounter errors when saving the integration.
Verifying Your Protocol Support
If your JIRA instance is self-hosted, you’ll also need to verify that your server uses HTTPs
as the protocol. Stitch does not support HTTP
for security reasons.
When you complete the JIRA setup in Stitch, you’ll be asked to enter your JIRA base URL. If Stitch determines that the protocol is not HTTPs
, connection errors will arise.
Retrieving the Stitch Public Key
- On the Stitch Dashboard page, click the Add an Integration button.
- Click the JIRA icon.
- Locate the Public Key field.
Leave this page open for now - you’ll need this to set up the application access in JIRA in the next step.
Granting Stitch Application Access to JIRA
Note that you need Administrator permissions to complete the steps in this section. If you’re not an Admin, loop in someone who can help you before continuing.
- Sign into your JIRA account.
- Click the Settings (gear) icon in the top-right corner.
- In the drop-down menu, click Applications.
- Click Application links - it’s in the Integrations section of the menu on the left side of the page.
- In the Application field, enter
stitchdata.com
. - Click Create new link.
A few ‘Configure Application URL’ messages might display after clicking the Create new link button. If you see these, don’t worry - everything is still on track. Click Continue to keep going.
Defining the First Set of Link Application Settings
- When the Link Applications window displays, enter
stitch
into the following fields:- Application Name
- Service Provider
- Consumer Key
- Shared Secret
- If the Application Type field doesn’t default to Generic Application, change it to this setting.
- Enter
stitchdata.com
in the following fields:- Request Token URL
- Token URL
- Authorize URL
- Check the Create incoming link box.
- Click the Continue button and a second Link Applications window will display.
Defining the Second Set of Link Application Settings
- In this window, enter
stitch
in these fields:- Consumer Key
- Consumer Name
- In the Public Key field, paste the entire Public Key from the Stitch JIRA credentials page.
- Click the Continue button.
If the link configuration was successful, you’ll see a Success! message on the Configure Application Links page.
Add JIRA as a Stitch Data Source
- On the Stitch Dashboard page, click the Add an Integration button.
-
Click the JIRA icon.
-
Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.
For example, the name “Stitch JIRA” would create a schema called
stitch_jira
in the data warehouse. This schema is where all the tables for this integration will be stored. - In the Base URL field, enter the base URL for your JIRA site. Remember: if you’re connecting a self-hosted instance, your server must use the
HTTPs
protocol or Stitch will be unable to successfully connect.
Defining the Historical Sync
The Sync Historical Data setting will define the starting date for your JIRA integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to sync data beyond JIRA’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.
Define the Replication Frequency
The Replication Frequency controls how often Stitch will attempt to replicate data from your JIRA integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.
Before setting the Replication Frequency, note that:
- The more often JIRA is set to replicate, the higher the number of replicated rows.
-
The number of rows in the source may not equal the number of rows replicated by Stitch. Tables that use Full Table Replication will result in a higher number of replicated rows.
- If you’re using a data warehouses that doesn’t natively support nested structures, you’ll see a higher number of replicated rows due to the de-nesting Stitch performs.
To help prevent overages, we recommend setting the Replication Frequency to something less frequent - like 6 hours instead of 30 minutes. For tips on reducing your row count, check out the Reducing Your Row Count section of our Billing Guide.
After selecting a Replication Frequency, click Save Integration.
JIRA’s Intial Sync
After you finish setting up JIRA, you might see its Sync Status show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial sync for the integration. This may take some time to complete.
JIRA Schema
Stitch's JIRA integration includes these tables:
- jira_issues
- jira_projects
- jira_project_categories
- jira_project_roles
- jira_project_types
- jira_resolutions
- jira_users
jira_issues
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
jira_issues
table contains info about the issues in your JIRA account.jira_issues & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
Accounting for Deleted Issues
When an issue is hard-deleted in JIRA, the record for the issue will remain in your data warehouse. This happens because of the Replication Method the jira_issues
table uses and how JIRA’s API functions.
- The
jira_issues
table is incrementally replicated based on theupdated_at
column. This means that rows with values in this column that are greater than or equal to the last recorded MAX value will be selected for replication. If a record is hard-deleted, there won’t be a value to check and thus no way to detect changes to the record. - JIRA’s API doesn’t include a flag to indicate deletes.
The suggested workaround (although it may be a bit cumbersome) is to use the fields__status__name
column - which indicates the current status of an issue - to track deletes. Before deleting the issue, you could change the status to something that would only indicate a delete and then use that status as a filter in your queries.
jira_issues Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Issue ID (
id
)self
key
expand
changelog
description
attachment
*
subtasks
*
labels
*
fixversions
*
comments
*
Creator Info
Status Info
Summary
Votes
Reporter
Priority
Issue Type
jira_projects
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
Yes
jira_projects
table contains info about individual projects in your JIRA account.jira_projects & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
jira_projects Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Project ID (
id
)avatarurls
description
expand
key
lead__active
lead__avatarurls
lead__displayname
lead__key
lead__name
lead__self
name
projecttypekey
projectkeys
*
self
jira_project_categories
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
jira_project_categories
table contains info about the categories assigned to the projects in your JIRA account.jira_project_categories Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Project Category ID (
id
)self
name
description
jira_project_roles
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
Yes
jira_project_roles
table contains info about the roles that can be assigned to projects in your JIRA account.jira_project_roles & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
jira_project_roles Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Project Role ID (
id
)self
name
description
jira_project_types
Replication Method: Full Table
Primary Key: key
Contains Nested Structures?:
No
jira_project_types
table contains info about the project types defined in your JIRA account.jira_project_types Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Project Type Key (
key
)formattedkey
description18nkey
icon
color
jira_resolutions
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
jira_resolutions
table contains info about the resolutions in your JIRA account.jira_resolutions Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Resolution ID (
id
)self
name
description
jira_users
Replication Method: Full Table
Primary Key: key
Contains Nested Structures?:
No
jira_users
table contains info about the users in your JIRA account.jira_users Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
User Key (
key
)active
avatarurls
displayname
emailaddress
key
locale
name
self
timezone
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, please reach out to us.