Skip to main content

​
Pre-requisites

  1. Jira Developer Portal. You can create one here.
  2. Required Settings for the app. You can find it in Overview.

​
Required Settings

  • Mandatory Scopes
  1. offline_access
  2. read:jira-work
If you haven’t already created an app in Jira, you’d need to create one.

​
Creating an app in Jira

To create a Jira app and acquire the above mentioned credentials, please follow the steps mentioned below:
  1. Log in to your Jira Developer Portal.
  2. Click on the Create button in the right and select OAuth 2.0 integration.
Navigation for App setup
  1. Enter the App Name for your application, agree to the Developer’s terms and click on Create.
  2. Go to your Apps catalog in Cobalt > Search for Jira > Settings > Use your credentials > Callback Url > Copy it.
  3. Navigate to Authorization in the side menu > Click on Add button under Action > Paste the Callback Url > Click on Save changes.
Setting up Jira Developer app
  1. Navigate to Permissions in the side menu > Click on Add button in Jira API > Click on Configure.
  2. Navigate to Classic scopes tab > Click on Edit Scopes button in Jira platform REST API > Select read:jira-work scope > Click on the Save button.
Scopes Selection in Jira App
  1. Navigate to Distribution in the side menu > Click on the Edit button > Change distribution status to Sharing and provide Vendor and Security Details > Click on Save Changes.
Note: Changing Distribution Status from Private to Sharing is necessary, otherwise only the Developer account user can install and use it.
  1. Navigate to Settings in the side menu, scroll down and copy the Client ID and Secret from Authentication details section.
Getting Credentials

​
Configuring credentials in Cobalt

App settings page lets you configure the authentication settings for an OAuth2 based application. For your customers to provide you authorization to access their data, they would first need to install your application. This page lets you set up your application credentials. Setting up application client credentials Cobalt lets you use pre-configured applications to play around. You can do so by selecting Use our credentials. However, if you wish to use your own application, select Use your own credentials. Provide the acquired Client Id and Client secret and click on Save changes.

​
Configuring Scopes

Cobalt lets you configure what permissions to ask from your users while they install your application. The scopes can be added or removed from the App settings page, under Permissions & Scopes section. For some applications Cobalt sets mandatory scopes which cannot be removed. Additional scopes can be selected from the drop down. Cobalt also has the provision to add any custom scopes supported by the respective platform. OAuth Scopes Once the scopes has been added to the application in Cobalt, go to your Jira Developer Portal and update the scopes as added on Cobalt. Select the OAuth App created for Cobalt > Click on Permissions in the left menu > Click Configure in Jira API > Click on Edit Scopes > Select the scope > Click on Save .
If you are facing scopes missing or invalid scope error. Make sure you are not passing any custom scope not supported by the platform. And, the scopes selected here are identical to the ones selected in the platform.

​
Jira Single Webhook URL

If you wish to create an orchestration where a workflow is being triggered when some operation occurs in Jira, you’d need to subscribe to Jira’s Webhook. Cobalt provides a single webhook URL to manage such event triggers for all your customers. To setup Jira webhook subscription:
  1. Select Jira from the application list in Cobalt, and select Settings.
  2. Copy the Single Webhook Url.
  3. In your Jira Admin account, click on Gear icon in the top right > Select System under Jira Settings.
Jira Webhooks Registration
  1. Scroll down in the side menu and select WebHooks.
  2. Click on + Create a WebHook, give it a Name, paste the Webhook URL that you copied under URL and add relevant events for which you want to be notified.
Make sure the WebHook created has the Enabled status.
Setting up Jira WebHook URL