Jira Connector
The Jira system connector in SyncNow allows users to synchronize, enrich, and link issues from Jira Cloud and Atlassian Service Desk with other work systems. SyncNow can automatically register Jira webhooks for continuous synchronization. The connector works with Jira Data Center, Jira Cloud, and Atlassian Service Desk.
🗂️ Key Features of the Jira Connector
- Entity Synchronization: Synchronize issues such as epics, stories, bugs, and service desk tickets from Jira to other work systems and vice versa.
- Field Synchronization: Synchronize comments, rich text fields (WIKI), links, select lists, statuses of sprints, releases, users, and attachments.
- Enrichment and Linking: Enrich, link, and add comments to every Jira entity.
⚙️ Setting Up the Jira Connector
To set up the Jira connector in SyncNow, follow these steps:
-
Navigate to the Systems Page
Access the "Systems" page from the main menu. -
Add a New System
Press the "Add System" button to create a new system connector. -
Configure the Jira Cloud Connector
- Name: Enter a unique name for the Jira Cloud connector.
- Type: Select “Jira Software Cloud” or "Atlassian Service Desk" from the "Type" dropdown menu.
- Allow Self-Signed Certificates: Enable or disable the toggle for self-signed certificates.
- URL: Provide the URL to the Jira instance.
- Username and Access Token: Enter the username and access token for the Jira instance. (Create an API token if not already done.)
- API Version (Optional): Add a preferred Jira API version. Currently, SyncNow supports only API v2.
- 🔒 Webhook Security: Configure system connector security options used for webhooks in SyncNow.
-
Verify and Save
- Press the "Verify Connection" button to check if the connection is established successfully.
- Press the "Save" button to save the connector settings.
🗂️ Major Supported Fields
SyncNow provides support for synchronizing a wide range of fields between Jira and other work systems:
| Field Name | Field Type | Sync Direction |
|---|---|---|
| Summary | Text | Bidirectional |
| Description | Rich Text (WIKI) | Bidirectional |
| Issue Type | Select List | Unidirectional (Jira to Other Systems) |
| Status | Select List | Bidirectional |
| Priority | Select List | Bidirectional |
| Labels | Multi-Select List | Bidirectional |
| Assignee | User | Bidirectional |
| Reporter | User | Bidirectional |
| Comments | Rich Text (WIKI) | Bidirectional |
| Attachments | File | Bidirectional |
| Due Date | Date | Bidirectional |
| Created Date | Date | Unidirectional (Jira to Other Systems) |
| Updated Date | Date | Unidirectional (Jira to Other Systems) |
| Fix Version | Select List | Bidirectional |
| Components | Multi-Select List | Bidirectional |
| Custom Fields | Various (Text, Number, Date, etc.) | Bidirectional |
| Sprints | Select List | Bidirectional |
| Epic | Link | Bidirectional |
| Sub-Tasks | Link | Bidirectional |
| Story Points | Number | Bidirectional |
| Resolution | Select List | Bidirectional |
| Environment | Text | Bidirectional |
| Original Estimate | Time Tracking | Bidirectional |
| Remaining Estimate | Time Tracking | Bidirectional |
| Time Spent | Time Tracking | Bidirectional |
- Embedded Attachments: SyncNow fully supports attachments and rich text fields with pictures. However, synchronization might have limitations depending on the target system's capabilities.
🏷️ Entity Types
The Jira connector supports synchronizing the following entity types:
- Epic
- Story
- Task
- Bug
- Sub-task
- Service Desk Ticket
- Custom Issue Types (any custom entity types defined in your Jira project)
ℹ️ Note:
You can map each Jira entity type to the appropriate entity type in your target system for flexible and accurate synchronization.
🧪 Jira - Xray Extension
SyncNow operators can use our predefined template with XRAY extension to synchronize requirements, tests, and defects to and from Jira Xray.
- SyncNow Xray extension has the ability to sync tests with test steps and attachments.
🛡️ Compatibility
The Jira System Connector supports the following:
- Jira Server | Data Center: Versions 7.x+
- Jira Cloud
- Atlassian Service Desk
🧩 Support for Custom Plugin Fields
SyncNow supports syncing custom plugin fields, which will be presented by default as text fields.
🧮 Support for Calculated and Scripted Fields
SyncNow supports scripted fields. These fields will be synced as strings as long as the Jira API returns them in a query.
🗃️ Fields and Jira Metadata
The Jira API returns fields that exist in the entity type’s screen.
If a field is not visible, its name can be manually written in lower case in the field entity mapping. For example, a field called "Critical Bugs Count" can be set as "critical bugs count".
⚠️ Limitations
The following limitations apply during system synchronization or migration:
- Field Visibility: Fields that do not appear on the Jira screen cannot be updated.
- Issue Type Change: Changing the issue type is not supported.
- Project Moves: Moving an issue from one project to another is not supported.
- Work Logs Synchronization: Timer synchronization for work logs will only be done for changed work logs with a start date within 4 days of the synchronization date.
- Schema Select List Fields: Values for schema select list fields are not created.
- Jira Cloud User Emails: User Emails are hidden by default, a change is required to show email to apps such as SyncNow. To change, navigate to account page → Profile and visibility Page → show email to anyone.
- Relation Changes for Timer Synchronization: In the default timer synchronization configuration, field changes are required to detect relationship changes. Jira does not notify SyncNow when only relations (like issue links) are added or removed. Sync processes subscribed to WebHooks will handle these changes as expected.
- Entity Type Changes: Changing the type of an entity is not supported.
- Rich Text Fields and Attachments: SyncNow supports synchronization of rich text fields and attachments, but embedded attachments within rich text fields are not supported.