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

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-jira

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.

  1. Sign into your Stitch account, if you haven’t already.
  2. Click User menu (your icon) > Manage Account Settings and locate the Data pipeline region section to verify your account’s region.
  3. Locate the list of IP addresses for your region:

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

  1. Sign into your JIRA account.
  2. Click the user menu (your icon) in the bottom left corner of the page.
  3. Click Profile.
  4. Click Manage your account.
  5. Click the Security tab.
  6. In the API token section, click the Create and manage API tokens link.
  7. On the page that displays, click the Create API token button.
  8. In the window that displays, enter a Label for the API token. For example: Stitch
  9. Click Create.
  10. 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

  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 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_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. For example: stitchdata.atlassian.net or stitchdata.atlassian.com

    Note: If you’re connecting a self-managed instance, your server must use the HTTPs protocol or Stitch will be unable to successfully connect.

  6. 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.
  7. 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 data equal to or newer than this date will be replicated to your data warehouse.

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:

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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

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

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

changelogs

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:

  1. The issues table must also be set to replicate. Note: When an issue is updated, all available changelogs for that issue will also be replicated.

  2. The Browse Projects project JIRA permission is required. Refer to JIRA’s API documentation for more info.

Replication Method

Key-based Incremental

Primary Key

id

Useful links

changelogs schema on GitHub

JIRA API method

Join changelogs with on
issue_comments
changelogs.issueId = issue_comments.issueId
changelogs.author.accountId = issue_comments.author.accountId
changelogs.author.accountId = issue_comments.updateAuthor.accountId
issue_transitions
changelogs.issueId = issue_transitions.issueId
issues
changelogs.issueId = issues.id
changelogs.author.accountId = issues.fields.attachment.author.accountId
worklogs
changelogs.issueId = worklogs.issueId
changelogs.author.accountId = worklogs.author.accountId
changelogs.author.accountId = worklogs.updateAuthor.accountId
components
changelogs.author.accountId = components.assignee.accountId
changelogs.author.accountId = components.componentBean.assignee.accountId
changelogs.author.accountId = components.componentBean.lead.accountId
changelogs.author.accountId = components.componentBean.realAssignee.accountId
changelogs.author.accountId = components.lead.accountId
changelogs.author.accountId = components.realAssignee.accountId
projects
changelogs.author.accountId = projects.components.assignee.accountId
changelogs.author.accountId = projects.components.lead.accountId
changelogs.author.accountId = projects.components.realAssignee.accountId
changelogs.author.accountId = projects.lead.accountId
users
changelogs.author.accountId = users.accountId

author

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

key

STRING

name

STRING

self

STRING

timeZone

STRING

created

DATE-TIME

historyMetadata

OBJECT

activityDescription

STRING

activityDescriptionKey

STRING

actor

OBJECT

avatarUrl

STRING

displayName

STRING

displayNameKey

STRING

id

STRING

type

STRING

url

STRING

cause

OBJECT

avatarUrl

STRING

displayName

STRING

displayNameKey

STRING

id

STRING

type

STRING

url

STRING

description

STRING

descriptionKey

STRING

emailDescription

STRING

emailDescriptionKey

STRING

extraData

OBJECT

generator

OBJECT

avatarUrl

STRING

displayName

STRING

displayNameKey

STRING

id

STRING

type

STRING

url

STRING

type

STRING

id

STRING

issueId

STRING

items

ARRAY

field

STRING

fieldId

STRING

fieldtype

STRING

from

STRING

fromString

STRING

to

STRING

toString

STRING

components

The components table contains info about components in projects in your JIRA account.

Replication requirements

Note: To replicate this data:

  1. The projects table must also be set to replicate, and
  2. The Browse Projects project JIRA permission is required. Refer to JIRA’s API documentation for more info.

Replication Method

Full Table

Primary Key

id

Useful links

components schema on GitHub

JIRA API method

Join components with on
projects
components.componentBean.projectId = projects.id
components.projectId = projects.id
components.assignee.accountId = projects.components.assignee.accountId
components.componentBean.assignee.accountId = projects.components.assignee.accountId
components.componentBean.lead.accountId = projects.components.assignee.accountId
components.componentBean.realAssignee.accountId = projects.components.assignee.accountId
components.lead.accountId = projects.components.assignee.accountId
components.realAssignee.accountId = projects.components.assignee.accountId
components.assignee.accountId = projects.components.lead.accountId
components.componentBean.assignee.accountId = projects.components.lead.accountId
components.componentBean.lead.accountId = projects.components.lead.accountId
components.componentBean.realAssignee.accountId = projects.components.lead.accountId
components.lead.accountId = projects.components.lead.accountId
components.realAssignee.accountId = projects.components.lead.accountId
components.assignee.accountId = projects.components.realAssignee.accountId
components.componentBean.assignee.accountId = projects.components.realAssignee.accountId
components.componentBean.lead.accountId = projects.components.realAssignee.accountId
components.componentBean.realAssignee.accountId = projects.components.realAssignee.accountId
components.lead.accountId = projects.components.realAssignee.accountId
components.realAssignee.accountId = projects.components.realAssignee.accountId
components.assignee.accountId = projects.lead.accountId
components.componentBean.assignee.accountId = projects.lead.accountId
components.componentBean.lead.accountId = projects.lead.accountId
components.componentBean.realAssignee.accountId = projects.lead.accountId
components.lead.accountId = projects.lead.accountId
components.realAssignee.accountId = projects.lead.accountId
versions
components.componentBean.projectId = versions.projectId
components.projectId = versions.projectId
changelogs
components.assignee.accountId = changelogs.author.accountId
components.componentBean.assignee.accountId = changelogs.author.accountId
components.componentBean.lead.accountId = changelogs.author.accountId
components.componentBean.realAssignee.accountId = changelogs.author.accountId
components.lead.accountId = changelogs.author.accountId
components.realAssignee.accountId = changelogs.author.accountId
issue_comments
components.assignee.accountId = issue_comments.author.accountId
components.componentBean.assignee.accountId = issue_comments.author.accountId
components.componentBean.lead.accountId = issue_comments.author.accountId
components.componentBean.realAssignee.accountId = issue_comments.author.accountId
components.lead.accountId = issue_comments.author.accountId
components.realAssignee.accountId = issue_comments.author.accountId
components.assignee.accountId = issue_comments.updateAuthor.accountId
components.componentBean.assignee.accountId = issue_comments.updateAuthor.accountId
components.componentBean.lead.accountId = issue_comments.updateAuthor.accountId
components.componentBean.realAssignee.accountId = issue_comments.updateAuthor.accountId
components.lead.accountId = issue_comments.updateAuthor.accountId
components.realAssignee.accountId = issue_comments.updateAuthor.accountId
issues
components.assignee.accountId = issues.fields.attachment.author.accountId
components.componentBean.assignee.accountId = issues.fields.attachment.author.accountId
components.componentBean.lead.accountId = issues.fields.attachment.author.accountId
components.componentBean.realAssignee.accountId = issues.fields.attachment.author.accountId
components.lead.accountId = issues.fields.attachment.author.accountId
components.realAssignee.accountId = issues.fields.attachment.author.accountId
users
components.assignee.accountId = users.accountId
components.componentBean.assignee.accountId = users.accountId
components.componentBean.lead.accountId = users.accountId
components.componentBean.realAssignee.accountId = users.accountId
components.lead.accountId = users.accountId
components.realAssignee.accountId = users.accountId
worklogs
components.assignee.accountId = worklogs.author.accountId
components.componentBean.assignee.accountId = worklogs.author.accountId
components.componentBean.lead.accountId = worklogs.author.accountId
components.componentBean.realAssignee.accountId = worklogs.author.accountId
components.lead.accountId = worklogs.author.accountId
components.realAssignee.accountId = worklogs.author.accountId
components.assignee.accountId = worklogs.updateAuthor.accountId
components.componentBean.assignee.accountId = worklogs.updateAuthor.accountId
components.componentBean.lead.accountId = worklogs.updateAuthor.accountId
components.componentBean.realAssignee.accountId = worklogs.updateAuthor.accountId
components.lead.accountId = worklogs.updateAuthor.accountId
components.realAssignee.accountId = worklogs.updateAuthor.accountId

assignee

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

16x16

STRING

24x24

STRING

32x32

STRING

48x48

STRING

displayName

STRING

self

STRING

assigneeType

STRING

componentBean

OBJECT

assignee

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

16x16

STRING

24x24

STRING

32x32

STRING

48x48

STRING

displayName

STRING

self

STRING

assigneeType

STRING

description

STRING

id

STRING

isAssigneeTypeValid

BOOLEAN

lead

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

16x16

STRING

24x24

STRING

32x32

STRING

48x48

STRING

displayName

STRING

self

STRING

name

STRING

project

STRING

projectId

INTEGER

realAssignee

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

16x16

STRING

24x24

STRING

32x32

STRING

48x48

STRING

displayName

STRING

self

STRING

realAssigneeType

STRING

self

STRING

description

STRING

id

STRING

isAssigneeTypeValid

BOOLEAN

issueCount

INTEGER

lead

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

16x16

STRING

24x24

STRING

32x32

STRING

48x48

STRING

displayName

STRING

self

STRING

name

STRING

project

STRING

projectId

INTEGER

realAssignee

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

16x16

STRING

24x24

STRING

32x32

STRING

48x48

STRING

displayName

STRING

self

STRING

realAssigneeType

STRING

self

STRING

issue_comments

The issue_comments table contains info about comments made on issues.

Replication requirements

To replicate this data:

  1. The issues table must also be set to replicate. Note: When an issue is updated, all the comments for that issue will also be replicated.
  2. The Browse Projects project JIRA permission is required. Refer to JIRA’s API documentation for more info.

Replication Method

Key-based Incremental

Primary Key

id

Useful links

issue_comments schema on GitHub

JIRA API method

Join issue_comments with on
changelogs
issue_comments.issueId = changelogs.issueId
issue_comments.author.accountId = changelogs.author.accountId
issue_comments.updateAuthor.accountId = changelogs.author.accountId
issue_transitions
issue_comments.issueId = issue_transitions.issueId
issues
issue_comments.issueId = issues.id
issue_comments.author.accountId = issues.fields.attachment.author.accountId
issue_comments.updateAuthor.accountId = issues.fields.attachment.author.accountId
worklogs
issue_comments.issueId = worklogs.issueId
issue_comments.author.accountId = worklogs.author.accountId
issue_comments.updateAuthor.accountId = worklogs.author.accountId
issue_comments.author.accountId = worklogs.updateAuthor.accountId
issue_comments.updateAuthor.accountId = worklogs.updateAuthor.accountId
components
issue_comments.author.accountId = components.assignee.accountId
issue_comments.updateAuthor.accountId = components.assignee.accountId
issue_comments.author.accountId = components.componentBean.assignee.accountId
issue_comments.updateAuthor.accountId = components.componentBean.assignee.accountId
issue_comments.author.accountId = components.componentBean.lead.accountId
issue_comments.updateAuthor.accountId = components.componentBean.lead.accountId
issue_comments.author.accountId = components.componentBean.realAssignee.accountId
issue_comments.updateAuthor.accountId = components.componentBean.realAssignee.accountId
issue_comments.author.accountId = components.lead.accountId
issue_comments.updateAuthor.accountId = components.lead.accountId
issue_comments.author.accountId = components.realAssignee.accountId
issue_comments.updateAuthor.accountId = components.realAssignee.accountId
projects
issue_comments.author.accountId = projects.components.assignee.accountId
issue_comments.updateAuthor.accountId = projects.components.assignee.accountId
issue_comments.author.accountId = projects.components.lead.accountId
issue_comments.updateAuthor.accountId = projects.components.lead.accountId
issue_comments.author.accountId = projects.components.realAssignee.accountId
issue_comments.updateAuthor.accountId = projects.components.realAssignee.accountId
issue_comments.author.accountId = projects.lead.accountId
issue_comments.updateAuthor.accountId = projects.lead.accountId
users
issue_comments.author.accountId = users.accountId
issue_comments.updateAuthor.accountId = users.accountId

author

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

key

STRING

name

STRING

self

STRING

timeZone

STRING

body

STRING

created

DATE-TIME

id

STRING

issueId

STRING

jsdPublic

BOOLEAN

properties

ARRAY

renderedBody

STRING

self

STRING

updateAuthor

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

key

STRING

name

STRING

self

STRING

timeZone

STRING

updated

DATE-TIME

visibility

OBJECT

type

STRING

value

STRING

issue_transitions

The issue_transitions table contains info about issue transitions.

Replication requirements

To replicate this data:

  1. The issues table must also be set to replicate. Note: When an issue is updated, all the transitions for that issue will also be replicated.
  2. The Browse Projects project JIRA permission is required. Refer to JIRA’s API documentation for more info.

Replication Method

Key-based Incremental

Loading Behavior

Append-Only

Primary Key

id

Useful links

issue_transitions schema on GitHub

JIRA API method

Join issue_transitions with on
changelogs
issue_transitions.issueId = changelogs.issueId
issue_comments
issue_transitions.issueId = issue_comments.issueId
issues
issue_transitions.issueId = issues.id
worklogs
issue_transitions.issueId = worklogs.issueId

expand

STRING

fields

OBJECT

hasScreen

BOOLEAN

id

STRING

isConditional

BOOLEAN

isGlobal

BOOLEAN

isInitial

BOOLEAN

issueId

STRING

name

STRING

to

OBJECT

description

STRING

iconUrl

STRING

id

STRING

name

STRING

self

STRING

statusCategory

OBJECT

colorName

STRING

id

INTEGER

key

STRING

name

STRING

self

STRING

statusColor

STRING

issues

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 `` column 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:

  1. Create a status in JIRA that will be applied to issues you want to delete.
  2. Before deleting the issue, apply the status.
  3. Allow Stitch to extract and load the updated data into your destination.
  4. Delete the issue.
  5. After Stitch finishes loading the data, use the fields__status__name field 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'
    

Replication Method

Key-based Incremental

Primary Key

id

Useful links

JIRA documentation

issues schema on GitHub

JIRA API method

Join issues with on
changelogs
issues.id = changelogs.issueId
issues.fields.attachment.author.accountId = changelogs.author.accountId
issue_comments
issues.id = issue_comments.issueId
issues.fields.attachment.author.accountId = issue_comments.author.accountId
issues.fields.attachment.author.accountId = issue_comments.updateAuthor.accountId
issue_transitions
issues.id = issue_transitions.issueId
worklogs
issues.id = worklogs.issueId
issues.fields.attachment.author.accountId = worklogs.author.accountId
issues.fields.attachment.author.accountId = worklogs.updateAuthor.accountId
components
issues.fields.attachment.author.accountId = components.assignee.accountId
issues.fields.attachment.author.accountId = components.componentBean.assignee.accountId
issues.fields.attachment.author.accountId = components.componentBean.lead.accountId
issues.fields.attachment.author.accountId = components.componentBean.realAssignee.accountId
issues.fields.attachment.author.accountId = components.lead.accountId
issues.fields.attachment.author.accountId = components.realAssignee.accountId
projects
issues.fields.attachment.author.accountId = projects.components.assignee.accountId
issues.fields.attachment.author.accountId = projects.components.lead.accountId
issues.fields.attachment.author.accountId = projects.components.realAssignee.accountId
issues.fields.attachment.author.accountId = projects.lead.accountId
users
issues.fields.attachment.author.accountId = users.accountId

editmeta

OBJECT

fields

OBJECT

expand

STRING

fields

OBJECT

attachment

ARRAY

created

DATE-TIME

lastViewed

DATE-TIME

updated

DATE-TIME

fieldsToInclude

OBJECT

id

STRING

key

STRING

names

OBJECT

properties

OBJECT

properties

OBJECT

renderedFields

OBJECT

schema

OBJECT

self

STRING

versionedRepresentations

OBJECT

project_categories

The project_categories table contains info about project categories.

Replication Method

Full Table

Primary Key

id

Useful links

project_categories schema on GitHub

JIRA API method

Join project_categories with on
projects
project_categories.id = projects.projectCategory.id

description

STRING

id

STRING

name

STRING

self

STRING

project_types

The project_types table contains info about project types.

Replication Method

Full Table

Primary Key

key

Useful links

project_types schema on GitHub

JIRA API method

color

STRING

descriptionI18nKey

STRING

formattedKey

STRING

icon

STRING

key

STRING

projects

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

Replication Method

Full Table

Primary Key

id

Useful links

projects schema on GitHub

JIRA documentation

Join projects with on
project_categories
projects.projectCategory.id = project_categories.id
components
projects.id = components.componentBean.projectId
projects.id = components.projectId
projects.components.assignee.accountId = components.assignee.accountId
projects.components.lead.accountId = components.assignee.accountId
projects.components.realAssignee.accountId = components.assignee.accountId
projects.lead.accountId = components.assignee.accountId
projects.components.assignee.accountId = components.componentBean.assignee.accountId
projects.components.lead.accountId = components.componentBean.assignee.accountId
projects.components.realAssignee.accountId = components.componentBean.assignee.accountId
projects.lead.accountId = components.componentBean.assignee.accountId
projects.components.assignee.accountId = components.componentBean.lead.accountId
projects.components.lead.accountId = components.componentBean.lead.accountId
projects.components.realAssignee.accountId = components.componentBean.lead.accountId
projects.lead.accountId = components.componentBean.lead.accountId
projects.components.assignee.accountId = components.componentBean.realAssignee.accountId
projects.components.lead.accountId = components.componentBean.realAssignee.accountId
projects.components.realAssignee.accountId = components.componentBean.realAssignee.accountId
projects.lead.accountId = components.componentBean.realAssignee.accountId
projects.components.assignee.accountId = components.lead.accountId
projects.components.lead.accountId = components.lead.accountId
projects.components.realAssignee.accountId = components.lead.accountId
projects.lead.accountId = components.lead.accountId
projects.components.assignee.accountId = components.realAssignee.accountId
projects.components.lead.accountId = components.realAssignee.accountId
projects.components.realAssignee.accountId = components.realAssignee.accountId
projects.lead.accountId = components.realAssignee.accountId
versions
projects.id = versions.projectId
changelogs
projects.components.assignee.accountId = changelogs.author.accountId
projects.components.lead.accountId = changelogs.author.accountId
projects.components.realAssignee.accountId = changelogs.author.accountId
projects.lead.accountId = changelogs.author.accountId
issue_comments
projects.components.assignee.accountId = issue_comments.author.accountId
projects.components.lead.accountId = issue_comments.author.accountId
projects.components.realAssignee.accountId = issue_comments.author.accountId
projects.lead.accountId = issue_comments.author.accountId
projects.components.assignee.accountId = issue_comments.updateAuthor.accountId
projects.components.lead.accountId = issue_comments.updateAuthor.accountId
projects.components.realAssignee.accountId = issue_comments.updateAuthor.accountId
projects.lead.accountId = issue_comments.updateAuthor.accountId
issues
projects.components.assignee.accountId = issues.fields.attachment.author.accountId
projects.components.lead.accountId = issues.fields.attachment.author.accountId
projects.components.realAssignee.accountId = issues.fields.attachment.author.accountId
projects.lead.accountId = issues.fields.attachment.author.accountId
users
projects.components.assignee.accountId = users.accountId
projects.components.lead.accountId = users.accountId
projects.components.realAssignee.accountId = users.accountId
projects.lead.accountId = users.accountId
worklogs
projects.components.assignee.accountId = worklogs.author.accountId
projects.components.lead.accountId = worklogs.author.accountId
projects.components.realAssignee.accountId = worklogs.author.accountId
projects.lead.accountId = worklogs.author.accountId
projects.components.assignee.accountId = worklogs.updateAuthor.accountId
projects.components.lead.accountId = worklogs.updateAuthor.accountId
projects.components.realAssignee.accountId = worklogs.updateAuthor.accountId
projects.lead.accountId = worklogs.updateAuthor.accountId

assigneeType

STRING

avatarUrls

OBJECT

components

ARRAY

assignee

OBJECT

accountId

STRING

active

BOOLEAN

applicationRoles

OBJECT

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

expand

STRING

groups

OBJECT

key

STRING

locale

STRING

name

STRING

self

STRING

timeZone

STRING

assigneeType

STRING

description

STRING

id

STRING

isAssigneeTypeValid

BOOLEAN

lead

OBJECT

accountId

STRING

active

BOOLEAN

applicationRoles

OBJECT

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

expand

STRING

groups

OBJECT

key

STRING

locale

STRING

name

STRING

self

STRING

timeZone

STRING

leadUserName

STRING

name

STRING

project

STRING

projectId

INTEGER

realAssignee

OBJECT

accountId

STRING

active

BOOLEAN

applicationRoles

OBJECT

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

expand

STRING

groups

OBJECT

key

STRING

locale

STRING

name

STRING

self

STRING

timeZone

STRING

realAssigneeType

STRING

self

STRING

description

STRING

email

STRING

expand

STRING

id

STRING

issueTypes

ARRAY

avatarId

INTEGER

description

STRING

iconUrl

STRING

id

STRING

name

STRING

self

STRING

subtask

BOOLEAN

key

STRING

lead

OBJECT

accountId

STRING

active

BOOLEAN

applicationRoles

OBJECT

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

expand

STRING

groups

OBJECT

key

STRING

locale

STRING

name

STRING

self

STRING

timeZone

STRING

name

STRING

projectCategory

OBJECT

description

STRING

id

STRING

name

STRING

self

STRING

projectKeys

ARRAY

projectTypeKey

STRING

roles

OBJECT

self

STRING

simplified

BOOLEAN

url

STRING

resolutions

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.

Replication Method

Full Table

Primary Key

id

Useful links

resolutions schema on GitHub

JIRA API method

description

STRING

iconUrl

STRING

id

STRING

name

STRING

self

STRING

roles

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.

Replication Method

Full Table

Primary Key

id

Useful links

roles schema on GitHub

JIRA API method

actors

ARRAY

avatarUrl

STRING

displayName

STRING

id

INTEGER

name

STRING

type

STRING

description

STRING

id

INTEGER

name

STRING

self

STRING

users

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.

Replication Method

Full Table

Primary Key

accountId

Useful links

users schema on GitHub

JIRA API method

Join users with on
changelogs
users.accountId = changelogs.author.accountId
components
users.accountId = components.assignee.accountId
users.accountId = components.componentBean.assignee.accountId
users.accountId = components.componentBean.lead.accountId
users.accountId = components.componentBean.realAssignee.accountId
users.accountId = components.lead.accountId
users.accountId = components.realAssignee.accountId
issue_comments
users.accountId = issue_comments.author.accountId
users.accountId = issue_comments.updateAuthor.accountId
issues
users.accountId = issues.fields.attachment.author.accountId
projects
users.accountId = projects.components.assignee.accountId
users.accountId = projects.components.lead.accountId
users.accountId = projects.components.realAssignee.accountId
users.accountId = projects.lead.accountId
worklogs
users.accountId = worklogs.author.accountId
users.accountId = worklogs.updateAuthor.accountId

accountId

STRING

accountType

STRING

active

BOOLEAN

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

expand

STRING

key

STRING

name

STRING

self

STRING

timeZone

STRING

versions

The versions table contains info about versions in your JIRA account.

Replication requirements

Note: To replicate this data:

  1. The projects table must also be set to replicate, and
  2. The Browse Projects project JIRA permission is required. Refer to JIRA’s API documentation for more info.

Replication Method

Full Table

Primary Key

id

Useful links

versions schema on GitHub

JIRA API method

Join versions with on
components
versions.projectId = components.componentBean.projectId
versions.projectId = components.projectId
projects
versions.projectId = projects.id

archived

BOOLEAN

description

STRING

expand

STRING

id

STRING

moveUnfixedIssuesTo

STRING

name

STRING

operations

ARRAY

href

STRING

iconClass

STRING

id

STRING

label

STRING

styleClass

STRING

title

STRING

weight

INTEGER

overdue

BOOLEAN

project

STRING

projectId

INTEGER

releaseDate

DATE-TIME

released

BOOLEAN

remotelinks

ARRAY

self

STRING

startDate

DATE-TIME

userReleaseDate

DATE-TIME

userStartDate

DATE-TIME

worklogs

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.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated

Useful links

worklogs schema on GitHub

JIRA API method

Join worklogs with on
changelogs
worklogs.issueId = changelogs.issueId
worklogs.author.accountId = changelogs.author.accountId
worklogs.updateAuthor.accountId = changelogs.author.accountId
issue_comments
worklogs.issueId = issue_comments.issueId
worklogs.author.accountId = issue_comments.author.accountId
worklogs.updateAuthor.accountId = issue_comments.author.accountId
worklogs.author.accountId = issue_comments.updateAuthor.accountId
worklogs.updateAuthor.accountId = issue_comments.updateAuthor.accountId
issue_transitions
worklogs.issueId = issue_transitions.issueId
issues
worklogs.issueId = issues.id
worklogs.author.accountId = issues.fields.attachment.author.accountId
worklogs.updateAuthor.accountId = issues.fields.attachment.author.accountId
components
worklogs.author.accountId = components.assignee.accountId
worklogs.updateAuthor.accountId = components.assignee.accountId
worklogs.author.accountId = components.componentBean.assignee.accountId
worklogs.updateAuthor.accountId = components.componentBean.assignee.accountId
worklogs.author.accountId = components.componentBean.lead.accountId
worklogs.updateAuthor.accountId = components.componentBean.lead.accountId
worklogs.author.accountId = components.componentBean.realAssignee.accountId
worklogs.updateAuthor.accountId = components.componentBean.realAssignee.accountId
worklogs.author.accountId = components.lead.accountId
worklogs.updateAuthor.accountId = components.lead.accountId
worklogs.author.accountId = components.realAssignee.accountId
worklogs.updateAuthor.accountId = components.realAssignee.accountId
projects
worklogs.author.accountId = projects.components.assignee.accountId
worklogs.updateAuthor.accountId = projects.components.assignee.accountId
worklogs.author.accountId = projects.components.lead.accountId
worklogs.updateAuthor.accountId = projects.components.lead.accountId
worklogs.author.accountId = projects.components.realAssignee.accountId
worklogs.updateAuthor.accountId = projects.components.realAssignee.accountId
worklogs.author.accountId = projects.lead.accountId
worklogs.updateAuthor.accountId = projects.lead.accountId
users
worklogs.author.accountId = users.accountId
worklogs.updateAuthor.accountId = users.accountId

author

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

key

STRING

name

STRING

self

STRING

timeZone

STRING

comment

STRING

created

DATE-TIME

id

STRING

issueId

STRING

properties

ARRAY

self

STRING

started

DATE-TIME

timeSpent

STRING

timeSpentSeconds

INTEGER

updateAuthor

OBJECT

accountId

STRING

active

BOOLEAN

avatarUrls

OBJECT

displayName

STRING

emailAddress

STRING

key

STRING

name

STRING

self

STRING

timeZone

STRING

updated

DATE-TIME

visibility

OBJECT

type

STRING

value

STRING


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.