This integration is powered by Singer's JIRA tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
JIRA integration summary
Stitch’s JIRA integration replicates data from a JIRA Cloud instance using the JIRA Cloud REST API v2. Refer to the Schema section for a list of objects available for replication.
JIRA feature snapshot
A high-level look at Stitch's JIRA (v2) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on February 28, 2020 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Supported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Supported |
| Select all |
Supported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting JIRA
JIRA setup requirements
To set up JIRA in Stitch, you need:
-
Access to the issues, projects, worklogs, etc. that you want to replicate. Stitch is only able to access the same objects that the user authenticating the integration has access to. If this user doesn’t have access to specific datasets or records, Stitch will be unable to replicate them from JIRA. Refer to JIRA’s documentation for more info about permissions in JIRA.
-
Certain date formats are not supported by this integration. Records with date formats from the following locales will be skipped during replication:
- Hungarian (Hungary) : Magyar
- Italian (Italy) : Italiano
- Japanese (Japan) : 日本語 (日本)
- Korean (South Korea) : 한국어 (대한민국)
- Polish (Poland) : Polski
- Thai (Thailand) : ภาษาไทย
- Turkish (Turkey) : Türkçe
- Chinese (China) : 中文 (简体)
- Chinese (Taiwan) : 中文 (繁體)
- Portuguese (Brazil) : português (Brasil)
- Portuguese (Portugal) : Português (Portugal)
- Vietnamese (Vietnam) : Tiếng Việt
Step 1: Verify self-managed configuration
Step 1.1: Verify your protocol support
To connect to a self-managed JIRA instance, your server must use 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.
Before proceeding, verify that your server uses HTTPs as the protocol.
Step 1.2: Whitelist Stitch's IP addresses
If your self-managed JIRA instance is behind a firewall, you’ll also need to whitelist Stitch’s IP addresses before proceeding. This ensures that Stitch will be allowed to access the instance. If you’re unsure how to do this, contact a member of your technical team for assistance.
The IP addresses you’ll whitelist depend on the Data pipeline region your account is in.
- Sign into your Stitch account, if you haven’t already.
- Click User menu (your icon) > Manage Account Settings and locate the Data pipeline region section to verify your account’s region.
-
Locate the list of IP addresses for your region:
- Whitelist the appropriate IP addresses for your Stitch data pipeline region.
Step 2: Generate a JIRA API token
To authenticate with a cloud-hosted JIRA instance, Stitch requires a JIRA username and an API token. In this step, you’ll generate an API token in JIRA.
- Sign into your JIRA account.
- Click the user menu (your icon) in the bottom left corner of the page.
- Click Profile.
- Click Manage your account.
- Click the Security tab.
- In the API token section, click the Create and manage API tokens link.
- On the page that displays, click the Create API token button.
- In the window that displays, enter a Label for the API token. For example:
Stitch - Click Create.
- A new window containing the API token will display. Copy the token before closing the window, as JIRA will only display it once.
Step 3: Add JIRA as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the JIRA icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard 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_jirain the destination. Note: Schema names cannot be changed after you save the integration. -
In the Base URL field, enter the base URL for your JIRA site. For example:
stitchdata.atlassian.netorstitchdata.atlassian.comNote: If you’re connecting a self-managed instance, your server must use the
HTTPsprotocol or Stitch will be unable to successfully connect. - In the Username field, enter the email address of the JIRA user you want to use to authenticate the integration. Note: Stitch will replicate only the issues, projects, worklogs, etc. that this user has access to. If this user doesn’t have access to specific datasets or records, Stitch will be unable to replicate them from JIRA.
- In the Password or Token field:
- If connecting a self-managed JIRA instance, enter the password associated with the user in the Username field.
- If connecting a cloud-hosted JIRA instance, paste the API token you generated in Step 2.
Step 4: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your JIRA integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- 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 destination.
Change this setting if you want to replicate data beyond JIRA’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 5: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
JIRA integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Please note that certain date formats are not supported by this integration. Records with date formats from the following locales will be skipped during replication:
- Hungarian (Hungary) : Magyar
- Italian (Italy) : Italiano
- Japanese (Japan) : 日本語 (日本)
- Korean (South Korea) : 한국어 (대한민국)
- Polish (Poland) : Polski
- Thai (Thailand) : ภาษาไทย
- Turkish (Turkey) : Türkçe
- Chinese (China) : 中文 (简体)
- Chinese (Taiwan) : 中文 (繁體)
- Portuguese (Brazil) : português (Brasil)
- Portuguese (Portugal) : Português (Portugal)
- Vietnamese (Vietnam) : Tiếng Việt
Step 6: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For JIRA integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up JIRA, its Sync Status may 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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
JIRA table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 2 of this integration.
This is the latest version of the JIRA integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
changelogs
| Replication Method : |
Key-based Incremental |
Replication Key  :
|
issues.updated |
Primary Key  :
|
id |
API endpoint : |
The changelogs table contains info about the changelogs associated with an issue.
Note: Due to a JIRA limitation in the endpoint Stitch uses to replicate changelogs, only the 100 most recent changelogs for any individual issue can be replicated. Refer to JIRA’s documentation for more info.
Replication requirements
To replicate this data:
-
The
issuestable must also be set to replicate. Note: When an issue is updated, all available changelogs for that issue will also be replicated. -
The
Browse Projectsproject JIRA permission is required. Refer to JIRA’s API documentation for more info.
|
id
The changelog ID. |
||||||||||||||||||||||||||||||
|
author
Details about the change log author.
changelogs (table), author (attribute)
|
||||||||||||||||||||||||||||||
|
created
The date and time the change log was created. |
||||||||||||||||||||||||||||||
|
historyMetadata
Details about issue history metadata.
|
||||||||||||||||||||||||||||||
|
issueId
The ID of the issue associated with the changelog. Reference: |
||||||||||||||||||||||||||||||
|
items
A list of change items associated with the changelog.
|
components
| Replication Method : |
Full Table |
Primary Key :
|
id |
| API endpoint : | |||
The components table contains info about components in projects in your JIRA account.
Replication requirements
Note: To replicate this data:
- The
projectstable must also be set to replicate, and - The
Browse Projectsproject JIRA permission is required. Refer to JIRA’s API documentation for more info.
issues
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updated |
|
Primary Key :
|
id |
API endpoint : |
The issues table contains info about the issues in your JIRA instance. This table only contains core issue data - some data is located in other tables, such as changelogs, issue_comments, and issue_transitions.
Note: To replicate this data, the Browse projects project JIRA permission for the project that the issue is in is required. Refer to JIRA’s API documentation for more info.
Identifying deleted issues
When an issue is hard-deleted in JIRA, the record for the issue will remain in your destination. This is due to the nature of Stitch Replication Keys and the design of JIRA’s API:
- Replication Keys: This table uses the values in the
updatedcolumn to identify new and updated data for replication. If a record is hard-deleted, there won’t be a value for Stitch to check and thus no way to identify the change, meaning the record will remain in the destination. - JIRA’s API: Currently, JIRA’s API doesn’t include a way to identify deleted issues.
To identify deleted issues, Atlassian’s suggested workaround is:
- Create a status in JIRA that will be applied to issues you want to delete.
- Before deleting the issue, apply the status.
- Allow Stitch to extract and load the updated data into your destination.
- Delete the issue.
-
After Stitch finishes loading the data, use the
fields__status__namefield in your queries to filter issues with the deleted status you applied in step 2. For example, the following query would return any issues that had been marked with a the deleted status:SELECT * FROM stitch_jira.issues WHERE fields__status__name = 'Deleted'
|
id
The issue ID. Reference: |
||||||||||||||||
|
expand
This field is used by Stitch to request data from JIRA. |
||||||||||||||||
|
self
The URL of the issue. |
||||||||||||||||
|
key
The issue key. |
||||||||||||||||
|
renderedFields
This field is used by Stitch to request data from JIRA. |
||||||||||||||||
|
names
The display names of the fields in the issue. |
||||||||||||||||
|
schema
The schema describing a field type.
|
||||||||||||||||
|
editmeta
Details about how each issue field can be edited.
|
||||||||||||||||
|
versionedRepresentations
This field is used by Stitch to request data from JIRA. |
||||||||||||||||
|
fieldsToInclude
This field is used by Stitch to request data from JIRA. |
||||||||||||||||
|
fields
Details about the fields in the issue. Note: While only a handful of fields are listed here, Stitch will replicate and persist any fields returned by JIRA’s API. This includes custom fields as well as standard issue fields such as
|
issue_comments
| Replication Method : |
Key-based Incremental |
Replication Key :
|
issues.updated |
|
Primary Key :
|
id |
API endpoint : |
The issue_comments table contains info about comments made on issues.
Replication requirements
To replicate this data:
- The
issuestable must also be set to replicate. Note: When an issue is updated, all the comments for that issue will also be replicated. - The
Browse Projectsproject JIRA permission is required. Refer to JIRA’s API documentation for more info.
|
id
The issue comment ID. |
||
|
author
Details about the author of the issue comment.
issue_comments (table), author (attribute)
|
||
|
body
The issue comment text in Atlassian Document Format. |
||
|
created
The date and time when the issue comment was created. |
||
|
issueId
The ID of the issue associated with the issue comment. Reference: |
||
|
jsdPublic
Indicates whether the issue comment is visible in JIRA service desk. |
||
|
properties
A list of issue comment properties.
|
||
|
renderedBody
The rendered version of the issue comment. |
||
|
self
The URL of the issue comment. |
||
|
updateAuthor
Details about the user who updated the issue comment.
issue_comments (table), updateAuthor (attribute)
|
||
|
updated
The date and time the issue comment was last updated. |
||
|
visibility
The group or role to which this issue comment is visible.
|
issue_transitions
| Replication Method : |
Key-based Incremental |
Replication Key :
|
issues.updated |
|
Primary Key :
|
id |
API endpoint : | |
| Loading Behavior: | |||
The issue_transitions table contains info about issue transitions.
Replication requirements
To replicate this data:
- The
issuestable must also be set to replicate. Note: When an issue is updated, all the transitions for that issue will also be replicated. - The
Browse Projectsproject JIRA permission is required. Refer to JIRA’s API documentation for more info.
|
id
The issue transition ID. |
|||||||||||||||||
|
expand
Details of expands available for the transition. |
|||||||||||||||||
|
fields
Details of the fields associated with the issue transition screen.
|
|||||||||||||||||
|
hasScreen
Indicates whether there is a screen associated with the issue transition. |
|||||||||||||||||
|
isConditional
Indicates whether the issue has to meet certain criteria before the issue transition can be applied. |
|||||||||||||||||
|
isGlobal
Indicates whether the issue transition is global, meaning the transition can be applied to issues regardless of status. |
|||||||||||||||||
|
isInitial
Indicates whether this is the initial issue transition for the workflow. |
|||||||||||||||||
|
issueId
The ID of the issue associated with the transition. Reference: |
|||||||||||||||||
|
name
The name of the issue transition. |
|||||||||||||||||
|
to
Details of the issue status after the transition.
|
projects
| Replication Method : |
Full Table |
Primary Key :
|
id |
| API endpoint : | |||
The projects table contains info about the projects in your JIRA account.
Note: Stitch will only replicate data from the projects that the user whose credentials are authenticating the integration can access. If there are missing projects, verify that the authenticating user (found in the integration’s Integration Settings page) has access to the missing projects.
|
id
The project ID. Reference: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
assigneeType
The default assignee when creating issues for the project. Possible values are:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
avatarUrls
The URLs associated with the avatars used by the project.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
components
A list of the components contained in the project.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
description
A description of the project. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
email
The email address associated with the project. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
expand
Details of expands available for project details. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issueTypes
A list of the issue types available in the project.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
key
The project key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lead
Details about the lead user associated with the project. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
name
The name of the project. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
projectCategory
The category associated with the project.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
projectKeys
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
projectTypeKey
The project type of the project. Possible values are:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
roles
The roles defined in the project.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
self
The URL of the project. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
simplified
Indicates whether the project is simplified. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
url
The URL of the project. |
project_categories
| Replication Method : |
Full Table |
Primary Key :
|
id |
| API endpoint : | |||
The project_categories table contains info about project categories.
|
id
The project category ID. Reference: |
|
description
The description of the project category. |
|
name
The name of the project category. |
|
self
The URL of the project category. |
project_types
| Replication Method : |
Full Table |
Primary Key :
|
key |
| API endpoint : | |||
The project_types table contains info about project types.
|
key
The project type key. |
|
color
The color of the project type. |
|
descriptionI18nKey
The key of the project type’s description. |
|
formattedKey
The formatted key of the project type. |
|
icon
The icon associated with the project type. |
resolutions
| Replication Method : |
Full Table |
Primary Key :
|
id |
| API endpoint : | |||
The resolutions table contains info about issue resolutions.
Note: To replicate this data, the Administer JIRA global JIRA permission is required. Refer to JIRA’s API documentation for more info.
|
id
The resolution ID. |
|
description
The description of the issue resolution. |
|
iconUrl
The URL of the icon for the issue resolution. |
|
name
The name of the issue resolution. |
|
self
The URL of the issue resolution. |
| Replication Method : |
Full Table |
Primary Key :
|
id |
| API endpoint : | |||
The roles table contains info about the project roles in your JIRA account.
Note: To replicate this data, the Administer JIRA global JIRA permission is required. Refer to JIRA’s API documentation for more info.
|
id
The project role ID. |
|||||
|
actors
Details about the user assigned this project role.
|
|||||
|
description
The description of the project role. |
|||||
|
name
The name of the project role. |
|||||
|
self
The URL of the project role. |
| Replication Method : |
Full Table |
Primary Key :
|
accountId |
| API endpoint : | |||
The users table contains info about the users in your JIRA account.
Note: To replicate this data, the Administer JIRA global JIRA permission is required. Refer to JIRA’s API documentation for more info.
|
accountId
The user’s account ID. Reference:
|
||||
|
active
Indicates if the user is active. |
||||
|
avatarUrls
The URLs associated with the avatars used by the user.
|
||||
|
displayName
The user’s display name. |
||||
|
emailAddress
The user’s email address. Depending on the user’s privacy settings, this may be returned as null.
|
||||
|
key
The key of the user. |
||||
|
name
The name of the user. |
||||
|
self
The URL for the user. |
||||
|
timeZone
The time zone specified in the user’s profile. Depending on the user’s privacy setting, this may be returned as null. |
versions
| Replication Method : |
Full Table |
Primary Key :
|
id |
| API endpoint : | |||
The versions table contains info about versions in your JIRA account.
Replication requirements
Note: To replicate this data:
- The
projectstable must also be set to replicate, and - The
Browse Projectsproject JIRA permission is required. Refer to JIRA’s API documentation for more info.
|
id
The project version ID. |
|||||||
|
archived
Indicates whether the version is archived. |
|||||||
|
description
The description of the vrsion. |
|||||||
|
expand
Details about the expands available for the project version. |
|||||||
|
moveUnfixedIssuesTo
The URL of the self link to the version to which all unfixed issues are moved when a version is released. |
|||||||
|
name
The name of the project version. |
|||||||
|
operations
The list of operations available in the version.
|
|||||||
|
overdue
Indicates whether the project version is overdue. |
|||||||
|
project
This field has been deprecated by JIRA. |
|||||||
|
projectId
The ID of the project this version is attached to. Reference: |
|||||||
|
releaseDate
The release date of the project version, expressed in ISO 8601 format. |
|||||||
|
released
Indicates whether the project version has been released. |
|||||||
|
remotelinks
The list of remote links stored against the project version.
|
|||||||
|
self
The URL of the project version. |
|||||||
|
startDate
The start date of the version, expressed in ISO 8601 format. |
|||||||
|
userReleaseDate
The date on which work on this version is expected to finish, in |
|||||||
|
userStartDate
The date on which work on this project version is expected to start, in |
worklogs
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updated |
|
Primary Key :
|
id |
API endpoint : |
The worklogs table contains info about the worklogs in your JIRA account.
Note: For a worklog to be replicated, it must be set as Viewable by All Users, or the integration authenticating user (visible in the integration’s Integration Settings page), must be a member of the project role/group with permission to view the worklog.
If you’re missing worklogs, verify that you have the required permissions to access the worklog.
|
id
The worklog ID. |
||
|
updated
The date and time the worklog was last updated. |
||
|
author
Details about the worklog’s author.
worklogs (table), author (attribute)
|
||
|
comment
A comment about the worklog. |
||
|
created
The date and time the worklog was created. |
||
|
issueId
The ID of the issue associated with the worklog. Reference: |
||
|
properties
Details of properties for the worklog.
|
||
|
self
The URL of the worklog. |
||
|
started
The date and time on which the worklog was started. |
||
|
timeSpent
The time spent working on the issue as days ( |
||
|
timeSpentSeconds
The time spent working on the issue, in seconds. |
||
|
updateAuthor
Details about the worklog’s update author.
worklogs (table), updateAuthor (attribute)
|
||
|
visibility
The group or role to which the worklog is visible.
|
| Related | Troubleshooting |
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.