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 (v1.0) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status

Released

Supported By

Stitch

Stitch Plan

Standard

Singer GitHub Repository

JIRA Repository

DATA SELECTION
Table Selection

Supported

Column Selection

Supported

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Unsupported

Table-level Reset

Unsupported

Configurable Replication Methods

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting JIRA

JIRA setup requirements

To set up JIRA in Stitch, you need:

  • A Standard Stitch plan. While those currently in the Free Trial will also be able to set up JIRA, replication will be paused until a Standard plan is selected after the trial ends.
  • 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.

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.

Whitelist the following IP addresses:

  • 52.23.137.21/32

  • 52.204.223.208/32

  • 52.204.228.32/32

  • 52.204.230.227/32

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

Step 6: Set tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in JIRA and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green 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.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

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 schemas

Replication Method :

Key-based Incremental

Replication Key :

issues.updated

Primary Key :

id

API endpoint :

Get issue change logs

The changelogs table contains info about the changelogs associated with an issue.

Replication requirements

To replicate this data:

  1. The issues table must also be set to replicate. Note: When an issue is updated, all the 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.

id
STRING

The changelog ID.

author
OBJECT

Details about the change log author.

accountId
STRING

The author’s account ID.

active
BOOLEAN

Indicates if the author is an active user.

avatarUrls
OBJECT

The URLs associated with the avatars used by the avatarUrls.

16x16
STRING

The URL of the 16x16’s 16x16 avatar.

24x24
STRING

The URL of the 24x24’s 24x24 avatar.

32x32
STRING

The URL of the 32x32’s 32x32 avatar.

48x48
STRING

The URL of the 48x48’s 48x48 avatar.

changelogs (table), avatarUrls (attribute)

displayName
STRING

The displayName’s display name.

emailAddress
STRING

The emailAddress’s email address.

key
STRING

The key ID.

Reference:

name
STRING

The name’s name.

self
STRING

The URL of the self in JIRA.

timeZone
STRING

The timeZone’s time zone.

changelogs (table), author (attribute)

created
DATE-TIME

The date and time the change log was created.

historyMetadata
OBJECT

Details about issue history metadata.

activityDescription
STRING

The activity described in the history record.

activityDescriptionKey
STRING

This field has been deprecated by JIRA.

actor
OBJECT

Details about the user whose action created the history record.

avatarUrl
STRING

The URL to an avatar for the user or system that the history record.

displayName
STRING

The display name of the user or system that the history record.

displayNameKey
STRING

This field has been deprecated by JIRA.

id
STRING

The ID of the user or system that the history record.

type
STRING

The type of the user or system that the history record.

url
STRING

The URL of the user or system that the history record.

changelogs (table), actor (attribute)

cause
OBJECT

Details about the caused that triggered the creation of the history record.

avatarUrl
STRING

The URL to an avatar for the user or system that the history record.

displayName
STRING

The display name of the user or system that the history record.

displayNameKey
STRING

This field has been deprecated by JIRA.

id
STRING

The ID of the user or system that the history record.

type
STRING

The type of the user or system that the history record.

url
STRING

The URL of the user or system that the history record.

changelogs (table), cause (attribute)

description
STRING

The description of the history record.

descriptionKey
STRING

This field has been deprecated by JIRA.

emailDescription
STRING

The description of the email address associated with the history record.

emailDescriptionKey
STRING

This field has been deprecated by JIRA.

extraData
OBJECT

Additional arbitrary information about the history record.

fieldName
STRING

The arbitrary information about the history record.

changelogs (table), extraData (attribute)

generator
OBJECT

Details about the user or system that generated the history record.

avatarUrl
STRING

The URL to an avatar for the user or system that the history record.

displayName
STRING

The display name of the user or system that the history record.

displayNameKey
STRING

This field has been deprecated by JIRA.

id
STRING

The ID of the user or system that the history record.

type
STRING

The type of the user or system that the history record.

url
STRING

The URL of the user or system that the history record.

changelogs (table), generator (attribute)

type
STRING

The type of the history record.

changelogs (table), historyMetadata (attribute)

issueId
STRING

The ID of the issue associated with the changelog.

Reference:

items
ARRAY

A list of change items associated with the changelog.

field
STRING

The name of the field that changed.

fieldId
STRING

The ID of the field that changed.

fieldtype
STRING

The type of the field that changed.

from
STRING

The details of the original field value.

fromString
STRING

The details of the original value as a string.

to
STRING

The details of the new value.

toString
STRING

The details of the new value as a string.

changelogs (table), items (attribute)

Replication Method :

Key-based Incremental

Replication Key :

issues.updated

Primary Key :

id

API endpoint :

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

id
STRING

The issue comment ID.

author
OBJECT

Details about the author of the issue comment.

accountId
STRING

The account ID of the user, which uniquely identifies the user across all Atlassian products.

active
BOOLEAN

Indicates whether the user is active.

avatarUrls
OBJECT

The URLs associated with the avatars used by the user.

16x16
STRING

The URL of the user’s 16x16 avatar.

24x24
STRING

The URL of the user’s 24x24 avatar.

32x32
STRING

The URL of the user’s 32x32 avatar.

48x48
STRING

The URL of the user’s 48x48 avatar.

issue_comments (table), avatarUrls (attribute)

displayName
STRING

The display name of the user. Depending on the user’s privacy settings, this may be returned an alternative value.

emailAddress
STRING

The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

key
STRING

The user’s key.

Reference:

name
STRING

The username of the user. Depending on the user’s privacy settings, this may be returned as null.

self
STRING

The URL of the user.

timeZone
STRING

The timezone specified in the user’s profile. Depending on the user’s privacy settings, this may be returned as null.

issue_comments (table), author (attribute)

body
STRING

The issue comment text in Atlassian Document Format.

created
DATE-TIME

The date and time when the issue comment was created.

issueId
STRING

The ID of the issue associated with the issue comment.

Reference:

jsdPublic
BOOLEAN

Indicates whether the issue comment is visible in JIRA service desk.

properties
ARRAY

A list of issue comment properties.

key
STRING

The key of the property.

value
ANYTHING

The value of the property.

issue_comments (table), properties (attribute)

renderedBody
STRING

The rendered version of the issue comment.

self
STRING

The URL of the issue comment.

updateAuthor
OBJECT

Details about the user who updated the issue comment.

accountId
STRING

The account ID of the user, which uniquely identifies the user across all Atlassian products.

active
BOOLEAN

Indicates whether the user is active.

avatarUrls
OBJECT

The URLs associated with the avatars used by the user.

16x16
STRING

The URL of the user’s 16x16 avatar.

24x24
STRING

The URL of the user’s 24x24 avatar.

32x32
STRING

The URL of the user’s 32x32 avatar.

48x48
STRING

The URL of the user’s 48x48 avatar.

issue_comments (table), avatarUrls (attribute)
issue_comments (table), updateAuthor (attribute)

updated
DATE-TIME

The date and time the issue comment was last updated.

visibility
OBJECT

The group or role to which this issue comment is visible.

type
STRING

Indicates whether the issue comment is restricted to a group or role. Possible values are group and role.

value
STRING

The name of the grou or role to which visibility of the issue comment is restricted.

issue_comments (table), visibility (attribute)

issue_transitions

Replication Method :

Key-based Incremental

Replication Key :

issues.updated

Primary Key :

id

API endpoint :

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

id
STRING

The issue transition ID.

expand
STRING

Details of expands available for the transition.

fields
OBJECT

Details of the fields associated with the issue transition screen.

anyFieldAtAll
OBJECT

allowedValues
ARRAY

The list of values allowed in the field.

value
VARIES

The value allowed in the field.

issue_transitions (table), allowedValues (attribute)

autoCompleteUrl
STRING

The URL that can be used to automatically complete the field.

defaultValue
ANYTHING

The default value of the field.

hasDefaultValue
BOOLEAN

Indicates whether the field has a default value.

key
STRING

The key of the field.

name
STRING

The name of the field.

operations
ARRAY

A list of operations that can be performed on the field.

value
STRING

The operation that can be performed on the field.

issue_transitions (table), operations (attribute)

required
BOOLEAN

Indicates whether the field is required.

schema
OBJECT

The data type of the field.

custom
STRING

If the field is a custom field, the URI of the field.

customId
INTEGER

If the field is a custom field, the ID of the custom field.

items
STRING

When the data type is array, the name of the field items within the array.

system
STRING

If the field is a system field, the name of the field.

type
STRING

The data type of the field.

issue_transitions (table), schema (attribute)
issue_transitions (table), anyFieldAtAll (attribute)
issue_transitions (table), fields (attribute)

hasScreen
BOOLEAN

Indicates whether there is a screen associated with the issue transition.

isConditional
BOOLEAN

Indicates whether the issue has to meet certain criteria before the issue transition can be applied.

isGlobal
BOOLEAN

Indicates whether the issue transition is global, meaning the transition can be applied to issues regardless of status.

isInitial
BOOLEAN

Indicates whether this is the initial issue transition for the workflow.

issueId
STRING

The ID of the issue associated with the transition.

Reference:

name
STRING

The name of the issue transition.

to
OBJECT

Details of the issue status after the transition.

description
STRING

The description of the transition status.

iconUrl
STRING

The URL of the transition status icon.

id
STRING

The ID of the transition status.

name
STRING

The name of the transition status.

self
STRING

The URL of the transition status.

statusCategory
OBJECT

The category assigned to the transition status.

colorName
STRING

The name of the color used to represent the status category.

id
INTEGER

The ID of the status category.

key
STRING

The key of the status category.

name
STRING

The name of the status category.

self
STRING

The URL of the status category.

issue_transitions (table), statusCategory (attribute)

statusColor
STRING

The name of the color of the transition status.

issue_transitions (table), to (attribute)

Replication Method :

Key-based Incremental

Replication Key :

updated

Primary Key :

id

API endpoint :

search(fields=*all, expand=changelog,transitions)

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 updated 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'
    

id
STRING

The issue ID.

Reference:

expand
STRING

This field is used by Stitch to request data from JIRA.

self
STRING

The URL of the issue.

key
STRING

The issue key.

renderedFields

This field is used by Stitch to request data from JIRA.

names
OBJECT

The display names of the fields in the issue.

patternProperties
STRING

issues (table), names (attribute)

schema
OBJECT

The schema describing a field type.

type
STRING

The data type of the field.

items
STRING

When the type is an array, the name of the field items within the array.

system
STRING

If the field is a system field, the name of the field.

custom
STRING

If the field is a custom field, the URI of the field.

customId
INTEGER

If the field is a custom field, the custom ID of the field.

issues (table), schema (attribute)

editmeta
OBJECT

Details about how each issue field can be edited.

required
BOOLEAN

Indicates whether the field is required.

schema
OBJECT

type
STRING

The data type of the field.

items
STRING

When the type is an array, the name of the field items within the array.

system
STRING

If the field is a system field, the name of the field.

custom
STRING

If the field is a custom field, the URI of the field.

customId
INTEGER

If the field is a custom field, the custom ID of the field.

issues (table), schema (attribute)

name
STRING

The name of the field.

key
STRING

The field key.

autoCompleteUrl
STRING

The URL that can be used to automatically complete the field.

hasDefaultValue
BOOLEAN

Indicates whether the field has a default value.

operations
ARRAY

The list of operations that can be performed on the field.

value
STRING

The operation that can be performed on the field.

issues (table), operations (attribute)

allowedValues
ARRAY

The list of values allowed in the field.

value
STRING

The value allowed in the field.

issues (table), allowedValues (attribute)

defaultValue
VARIES

The default value of the field.

issues (table), editmeta (attribute)

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
OBJECT

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 assignee or description.

updated
DATE-TIME

The date and time the field was last updated.

created
DATE-TIME

The date and time the field was created.

lastViewed
DATE-TIME

The date and time the field was last viewed.

attachment
ARRAY

Details about issue attachment.

id
STRING

The attachment ID.

self
STRING

The URL of the attachment.

thumbnail
STRING

The URL of the thumbnail version of the attachment.

filename
STRING

The filename of the attachment.

created
DATE-TIME

The date and time when the attachment was created.

author
OBJECT

Details about the attachment author.

accountId
STRING

The author’s account ID.

active
BOOLEAN

Indicates if the author is an active user.

avatarUrls
OBJECT

The URLs associated with the avatars used by the avatarUrls.

16x16
STRING

The URL of the 16x16’s 16x16 avatar.

24x24
STRING

The URL of the 24x24’s 24x24 avatar.

32x32
STRING

The URL of the 32x32’s 32x32 avatar.

48x48
STRING

The URL of the 48x48’s 48x48 avatar.

issues (table), avatarUrls (attribute)

displayName
STRING

The displayName’s display name.

emailAddress
STRING

The emailAddress’s email address.

key
STRING

The key ID.

Reference:

name
STRING

The name’s name.

self
STRING

The URL of the self in JIRA.

timeZone
STRING

The timeZone’s time zone.

issues (table), author (attribute)
issues (table), attachment (attribute)
issues (table), fields (attribute)

project_categories

Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get all project categories

The project_categories table contains info about project categories.

id
STRING

The project category ID.

Reference:

description
STRING

The description of the project category.

name
STRING

The name of the project category.

self
URI

The URL of the project category.


Replication Method :

Full Table

Primary Key :

key

API endpoint :

Get all project types

The project_types table contains info about project types.

key
STRING

The project type key.

color
STRING

The color of the project type.

descriptionI18nKey
STRING

The key of the project type’s description.

formattedKey
STRING

The formatted key of the project type.

icon
STRING

The icon associated with the project type.


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get all projects

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
STRING

The project ID.

Reference:

assigneeType
STRING

The default assignee when creating issues for the project. Possible values are:

  • PROJECT_LEAD
  • UNASSIGNED

avatarUrls
OBJECT

The URLs associated with the avatars used by the project.

16x16
STRING

The URL of the project’s 16x16 avatar.

24x24
STRING

The URL of the project’s 24x24 avatar.

32x32
STRING

The URL of the project’s 32x32 avatar.

48x48
STRING

The URL of the project’s 48x48 avatar.

projects (table), avatarUrls (attribute)

components
ARRAY

A list of the components contained in the project.

id
STRING

The component ID.

assignee
OBJECT

accountId
STRING

The assignee’s account ID.

active
BOOLEAN

Indicates if the assignee is active.

applicationRoles
OBJECT

Application roles associated with the assignee.

items
ARRAY

A list of application roles associated with the assignee.

name
STRING

The name of the application role.

self
STRING

The URL of the application role.

projects (table), items (attribute)

max-results
INTEGER

size
INTEGER

projects (table), applicationRoles (attribute)

avatarUrls
OBJECT

The URLs associated with the avatars used by the assignee.

16x16
STRING

The URL of the assignee’s 16x16 avatar.

24x24
STRING

The URL of the assignee’s 24x24 avatar.

32x32
STRING

The URL of the assignee’s 32x32 avatar.

48x48
STRING

The URL of the assignee’s 48x48 avatar.

projects (table), avatarUrls (attribute)

displayName
STRING

The assignee’s display name. Depending on the user’s privacy setting, this may be returned as null.

emailAddress
STRING

The assignee’s email address. Depending on the user’s privacy setting, this may be returned as null.

expand
STRING

Details of expands available for the assignee details.

groups
OBJECT

Details about the groups the assignee is associated with.

items
ARRAY

The groups the assignee is associated with.

name
STRING

The name of the group.

self
STRING

The URL for the group.

projects (table), items (attribute)

max-results
INTEGER

size
INTEGER

projects (table), groups (attribute)

key
STRING

The key of the assignee.

Reference:

locale
STRING

The locale of the assignee. Depending on the user’s privacy setting, this may be returned as null.

name
STRING

The name of the assignee.

self
STRING

The URL for the assignee.

timeZone
STRING

The time zone specified in the assignee’s profile. Depending on the user’s privacy setting, this may be returned as null.

projects (table), assignee (attribute)

assigneeType
STRING

The user type used to determine the assignee for issues created with this component. Possible values are:

  • COMPONENT_LEAD - The assignee to any issues created with this component is nominally the lead for the component.
  • PROJECT_DEFAULT - The assignee to any issues created with this component is nominally the default assignee for the project the component is in.
  • PROJECT_LEAD - The assignee to any issues created with this component is nominally the lead for the project the component is in.
  • UNASSIGNED - An assignee is not set for issues created with this component.

description
STRING

A description of the component.

isAssigneeTypeValid
BOOLEAN

Indicates if the assigneeType is valid.

lead
OBJECT

Details about the lead user associated with the project.

accountId
STRING

The lead user’s account ID.

active
BOOLEAN

Indicates if the lead user is active.

applicationRoles
OBJECT

Application roles associated with the lead user.

items
ARRAY

A list of application roles associated with the lead user.

name
STRING

The name of the application role.

self
STRING

The URL of the application role.

projects (table), items (attribute)

max-results
INTEGER

size
INTEGER

projects (table), applicationRoles (attribute)

avatarUrls
OBJECT

The URLs associated with the avatars used by the lead user.

16x16
STRING

The URL of the lead user’s 16x16 avatar.

24x24
STRING

The URL of the lead user’s 24x24 avatar.

32x32
STRING

The URL of the lead user’s 32x32 avatar.

48x48
STRING

The URL of the lead user’s 48x48 avatar.

projects (table), avatarUrls (attribute)

displayName
STRING

The lead user’s display name. Depending on the user’s privacy setting, this may be returned as null.

emailAddress
STRING

The lead user’s email address. Depending on the user’s privacy setting, this may be returned as null.

expand
STRING

Details of expands available for the lead user details.

groups
OBJECT

Details about the groups the lead user is associated with.

items
ARRAY

The groups the lead user is associated with.

name
STRING

The name of the group.

self
STRING

The URL for the group.

projects (table), items (attribute)

max-results
INTEGER

size
INTEGER

projects (table), groups (attribute)

key
STRING

The key of the lead user.

Reference:

locale
STRING

The locale of the lead user. Depending on the user’s privacy setting, this may be returned as null.

name
STRING

The name of the lead user.

self
STRING

The URL for the lead user.

timeZone
STRING

The time zone specified in the lead user’s profile. Depending on the user’s privacy setting, this may be returned as null.

projects (table), lead (attribute)

leadUserName
STRING

The username of the component’s lead user.

name
STRING

The name of the component.

project
STRING

The key of the project to which the component is assignee.

projectId
INTEGER

Not used.

realAssignee
OBJECT

Details about the real assignee associated with the component.

realAssigneeType
STRING

The actual type of the assignee to issues created with this component, when an assignee cannot be set from the assigneeType. Possible values are:

  • COMPONENT_LEAD - When assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.
  • PROJECT_LEAD - When assigneeType is PROJECT_LEAD and the project lead has permission to be assigneed issues in the project that the component is in.
  • UNASSIGNED - When assigneeType is UNASSIGNED and JIRA is configured to allow unassigned issues.
  • PROJECT_DEFAULT - When none of the preceeding cases are true.

self
STRING

The URL of the component.

projects (table), components (attribute)

description
STRING

A description of the project.

email
STRING

The email address associated with the project.

expand
STRING

Details of expands available for project details.

issueTypes
ARRAY

A list of the issue types available in the project.

avatarId
INTEGER

The ID of the issue type’s avatar.

description
STRING

The description of the issue type.

iconUrl
STRING

The URL of the issue type’s avatar.

id
STRING

The ID of the issue type.

name
STRING

The name of the issue type.

self
STRING

The URL of the issue type.

subtask
BOOLEAN

Indicates whether the issue type can be used to create subtasks.

projects (table), issueTypes (attribute)

key
STRING

The project key.

lead
OBJECT

Details about the lead user associated with the project.

name
STRING

The name of the project.

projectCategory
OBJECT

The category associated with the project.

description
STRING

The description of the project category.

id
STRING

The ID of the project category.

Reference:

name
STRING

The name of the project category.

self
STRING

The URL of the project category.

projects (table), projectCategory (attribute)

projectKeys
ARRAY

value
STRING

projects (table), projectKeys (attribute)

projectTypeKey
STRING

The project type of the project. Possible values are:

  • ops
  • software
  • service_desk
  • business

roles
OBJECT

The roles defined in the project.

varies
STRING

The role defined in the project.

projects (table), roles (attribute)

self
STRING

The URL of the project.

simplified
BOOLEAN

Indicates whether the project is simplified.

url
STRING

The URL of the project.


Replication Method :

Full Table

Primary Key :

id

API endpoint :

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

id
STRING

The resolution ID.

description
STRING

The description of the issue resolution.

iconUrl
STRING

The URL of the icon for the issue resolution.

name
STRING

The name of the issue resolution.

self
URI

The URL of the issue resolution.


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get project 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.

id
INTEGER

The project role ID.

actors
ARRAY

Details about the user assigned this project role.

avatarUrl
STRING

The URL of the user’s avatar.

displayName
STRING

The display name of the user. Depending on the user’s privacy setting, this may be returned as null.

id
INTEGER

The user’s ID.

name
STRING

The name of the user.

type
STRING

The type of the user.

roles (table), actors (attribute)

description
STRING

The description of the project role.

name
STRING

The name of the project role.

self
URI

The URL of the project role.


Replication Method :

Full Table

Primary Key :

key

API endpoint :

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

key
STRING

The user key.

Reference:

accountId
STRING

The user’s account ID.

active
BOOLEAN

Indicates if the user is active.

max-results
INTEGER

size
INTEGER

users (table), active (attribute)

avatarUrls
OBJECT

The URLs associated with the avatars used by the user.

16x16
STRING

The URL of the user’s 16x16 avatar.

24x24
STRING

The URL of the user’s 24x24 avatar.

32x32
STRING

The URL of the user’s 32x32 avatar.

48x48
STRING

The URL of the user’s 48x48 avatar.

users (table), avatarUrls (attribute)

displayName
STRING

The user’s display name.

emailAddress
STRING

The user’s email address. Depending on the user’s privacy settings, this may be returned as null.

max-results
INTEGER

size
INTEGER

users (table), emailAddress (attribute)

key
STRING

The key of the user.

name
STRING

The name of the user.

self
STRING

The URL for the user.

timeZone
STRING

The time zone specified in the user’s profile. Depending on the user’s privacy setting, this may be returned as null.


Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get project 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.

id
STRING

The project version ID.

archived
BOOLEAN

Indicates whether the version is archived.

description
STRING

The description of the vrsion.

expand
STRING

Details about the expands available for the project version.

moveUnfixedIssuesTo
STRING

The URL of the self link to the version to which all unfixed issues are moved when a version is released.

name
STRING

The name of the project version.

operations
ARRAY

The list of operations available in the version.

href
STRING

iconClass
STRING

The icon class of the operation.

id
STRING

The ID of the operation.

label
STRING

The label of the operation.

styleClass
STRING

The style class of the operation.

title
STRING

The title of the operation.

weight
INTEGER

The weight of the operation.

versions (table), operations (attribute)

overdue
BOOLEAN

Indicates whether the project version is overdue.

project
STRING

This field has been deprecated by JIRA.

projectId
INTEGER

The ID of the project this version is attached to.

Reference:

releaseDate
DATE-TIME

The release date of the project version, expressed in ISO 8601 format.

released
BOOLEAN

Indicates whether the project version has been released.

remotelinks
ARRAY

The list of remote links stored against the project version.

self
STRING

The URL of the project version.

startDate
DATE-TIME

The start date of the version, expressed in ISO 8601 format.

userReleaseDate
DATE-TIME

The date on which work on this version is expected to finish, in Day/Month/Year format.

userStartDate
DATE-TIME

The date on which work on this project version is expected to start, in Day/Month/Year format.


Replication Method :

Key-based Incremental

Replication Key :

updated

Primary Key :

id

API endpoint :

Get IDs of updated 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.

id
STRING

The worklog ID.

updated
DATE-TIME

The date and time the worklog was last updated.

author
OBJECT

Details about the worklog’s author.

accountId
STRING

The worklog author’s account ID.

active
BOOLEAN

Indicates if the worklog author is active.

avatarUrls
OBJECT

The URLs associated with the avatars used by the worklog author.

16x16
STRING

The URL of the worklog author’s 16x16 avatar.

24x24
STRING

The URL of the worklog author’s 24x24 avatar.

32x32
STRING

The URL of the worklog author’s 32x32 avatar.

48x48
STRING

The URL of the worklog author’s 48x48 avatar.

worklogs (table), avatarUrls (attribute)

displayName
STRING

The worklog author’s display name. Depending on the worklog author’s privacy setting, this may be returned as an alternative value.

emailAddress
STRING

The worklog author’s email address. Depending on the worklog author’s privacy settings, this may be returned as null.

key
STRING

The key of the worklog author.

Reference:

locale
STRING

The locale of the worklog author. Depending on the worklog author’s privacy setting, this may be returned as null.

name
STRING

The name of the worklog author.

self
STRING

The URL for the worklog author.

timeZone
STRING

The time zone specified in the user’s profile. Depending on the user’s privacy setting, this may be returned as null.

worklogs (table), author (attribute)

comment
STRING

A comment about the worklog.

created
DATE-TIME

The date and time the worklog was created.

issueId
STRING

The ID of the issue associated with the worklog.

Reference:

properties
ARRAY

Details of properties for the worklog.

key
STRING

The key of the property.

value
ANYTHING

The value of the property.

worklogs (table), properties (attribute)

self
STRING

The URL of the worklog.

started
DATE-TIME

The date and time on which the worklog was started.

timeSpent
STRING

The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #).

timeSpentSeconds
INTEGER

The time spent working on the issue, in seconds.

updateAuthor
OBJECT

Details about the worklog’s update author.

accountId
STRING

The update author’s account ID.

active
BOOLEAN

Indicates if the update author is active.

avatarUrls
OBJECT

The URLs associated with the avatars used by the update author.

16x16
STRING

The URL of the update author’s 16x16 avatar.

24x24
STRING

The URL of the update author’s 24x24 avatar.

32x32
STRING

The URL of the update author’s 32x32 avatar.

48x48
STRING

The URL of the update author’s 48x48 avatar.

worklogs (table), avatarUrls (attribute)

displayName
STRING

The update author’s display name. Depending on the update author’s privacy setting, this may be returned as an alternative value.

emailAddress
STRING

The update author’s email address. Depending on the update author’s privacy settings, this may be returned as null.

key
STRING

The key of the update author.

Reference:

locale
STRING

The locale of the update author. Depending on the update author’s privacy setting, this may be returned as null.

name
STRING

The name of the update author.

self
STRING

The URL for the update author.

timeZone
STRING

The time zone specified in the user’s profile. Depending on the user’s privacy setting, this may be returned as null.

worklogs (table), updateAuthor (attribute)

visibility
OBJECT

The group or role to which the worklog is visible.

type
STRING

Indicates whether visibility of the worklog is restricted to a group or role. Possible values are:

  • group
  • role

value
STRING

The name of the group or role to which invisibility of the worklog is restricted.

worklogs (table), visibility (attribute)


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.