Jira Platform Setup

  • Updated

The Jira Platform Synapse enables data synchronization between Jira Platform objects and Syncari entities using the Jira API. After the Synapse is Authenticated, a user can Activate the Jira Platform Synapse, which enables Syncari to replicate the schema of your Jira Platform project and make it available within the Unified Data Model. Using the Sync Studio, a user can map Jira Platform objects to Syncari entities, and Jira Service Management fields to Syncari fields. 

If your Jira security requires you to whitelist an IP you can find that here.


Jira Setup

You will need the following information from your Jira Service Management subscription:

  • Endpoint URL (eg. https://reade.atlassian.net)
  • Service Desk ID (eg. FA)
  • Username
  • API Token

Follow these steps in Jira Service Management to prepare the integration between Jira Service Management and Syncari:

  1. Login to Jira Service Management
  2. Navigate to your Help Center Project


  1. Copy your Endpoint URL
  2. Copy your Project Key
  3. Navigate to your Profile

You will need to generate an API Key in Jira in order to complete the Synapse Setup (see below). You can do this from your Jira Profile.


  1. Click "Manage your account"

Follow these steps to create your API Token:


  1. Click Security
  2. Click "Create and manage API Tokens"

Follow these step to complete the process of creating your API Token:


  1. Click "API Tokens"
  2. Click "Create API Token"

Follow the prompts to complete the process for creating an API Key. 


Nice! You are now ready to configure your Jira Synapse in Syncari.


Synapse Setup

Step 1: Start by logging in to your Syncari subscription

  1. Navigate to Synapses
  2. Find Jira in the Synapse Library
  3. Drag the Jira Synapse to the canvas


Step 2: Configure your Synapse parameters

  1. Enter [Synapse Name]
  2. Enter [Endpoint URL] 
  3. Enter [Project Key] 
  4. Click Next


Step 3: Define your authentication parameters

  1. Enter [Username]
  2. Enter [API Key]


Step 4: Authenticate your Synapse:

  1. Click "Authenticate"


Step 5: Activate your Synapse

  1. Click "Next"
  2. Click "Make Synapse Active"
  3. Click "Close"


Congratulations! You have completed the setup of Jira Platform. 

If you receive any errors message after clicking Authenticate, confirm each of the parameters in the previous steps are configured properly. If the error persists, contact one of our Onboarding and Support team members.

Share this

Was this article helpful?

0 out of 0 found this helpful