Release Status Released Supported By Stitch
Availability Premium Status Page JIRA Status Page
Default Historical Sync 1 year Default Replication Frequency 30 minutes
Whitelisting Unsupported Destination Incompatibilities None

Connecting JIRA

Depending on your setup, connecting JIRA is a five or seven-step process:

  1. Whitelist Stitch’s IP Addresses *
  2. Verify protocol support *
  3. Retrieve the Stitch Public Key
  4. Grant Stitch application access to JIRA
  5. Add JIRA as a Stitch data source
  6. Define the Historical Sync
  7. 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.

Whitelist 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.

Verify 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.

Retrieve the Stitch Public Key

  1. On the Stitch Dashboard page, click the Add Integration button.
  2. Click the JIRA icon.
  3. 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.

Grant 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.

  1. Sign into your JIRA account.
  2. Click the Settings (gear) icon in the top-right corner.
  3. In the drop-down menu, click Applications.
  4. Click the Application link - it’s in the Integrations section of the menu on the left side of the page.
  5. In the Application field, enter stitchdata.com.
  6. 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.

  1. When the Link Applications window displays, enter stitch into the following fields:
    • Application Name
    • Service Provider Name
  2. Set the Application Type field to Generic Application.
  3. Enter rjmetrics into the following fields:
    • Consumer Key
    • Shared Secret
  4. Enter stitchdata.com into the following fields:
    • Request Token URL
    • Token URL
    • Authorize URL
  5. Check the Create incoming link box.
  6. Click the Continue button and a second Link Applications window will display.
  1. In the Consumer Key field, enter rjmetrics.
  2. In the Consumer Name field, enter stitch.
  3. In the Public Key field, paste the entire Public Key from the Stitch JIRA credentials page.
  4. 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

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the JIRA icon.

  4. 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 destination.

    For example, the name “Stitch JIRA” would create a schema called stitch_jira in the destination. Note: Schema names cannot be changed after you save the integration.

  5. 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.

Define the Historical Sync

The Sync Historical Data setting will define the starting date for your JIRA integration. This means that:

  • For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
  • For tables using Full Table Replication, all data - including records that are older, 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 guide.

Define the Replication Frequency

The Replication Frequency controls how often Stitch will attempt to extract data from your JIRA integration.

Note: This setting only affects the frequency of data extraction from JIRA, not the interval at which data is loaded into your data warehouse. For example: a one (1) minute Replication Frequency means Stitch will attempt to extract data every minute, but loading the extracted data may take longer than this.

Use the Default Frequency

To use the default Replication Frequency (30 minutes), leave the Use integration default box checked and click Save Integration to create the integration.

Customize the Frequency

To adjust the Replication Frequency:

  1. Uncheck the Use integration default checkbox. A slider with various frequencies will display.
  2. Click the desired frequency on the slider.
  3. Click Save Integration to create the integration.

To help prevent overages, consider setting the integration to replicate less frequently. See the Understanding & Reducing Your Row Usage guide for tips on reducing your usage.

JIRA’s Intial Replication Job

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 replication job for the integration. This may take some time to complete.


JIRA Schema

Stitch's JIRA integration includes these tables:


jira_issues

Replication Method: Incremental
Primary Key: id
Contains Nested Structures?: Yes

The jira_issues table contains info about the issues in your JIRA account.

Table Info & Attributes

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 the updated_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

The jira_projects table contains info about individual projects in your JIRA account.

Table Info & Attributes

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

The jira_project_categories table contains info about the categories assigned to the projects in your JIRA account.

Table Info & Attributes

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

The jira_project_roles table contains info about the roles that can be assigned to projects in your JIRA account.

Table Info & Attributes

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.

jira_project_types

Replication Method: Full Table
Primary Key: key
Contains Nested Structures?: No

The jira_project_types table contains info about the project types defined in your JIRA account.

Table Info & Attributes

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

The jira_resolutions table contains info about the resolutions in your JIRA account.

Table Info & Attributes

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

The jira_users table contains info about the users in your JIRA account.

Table Info & Attributes

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



Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.