Jira

Get authentication details

To authenticate the connector, you need to obtain your authentication details.

To create an API token for your Jira account, go to the Manage API tokens for your Atlassian account page of the Atlassian documentation and follow the instructions under the Create an API token heading.

Use the API token in place of your Jira account password when authenticating a Jira connector in Cyclr.

Cyclr setup

Account setup

Cyclr asks you for the below values when you install a Jira connector into an account:

Note: You can use different details for different accounts.

Map issue properties

To map an issue property field in a cycle, you need to add a custom field location:

1. Map the Update Issue Property.

2. Map the Get Issue Properties.

Map Update Issue Property

To add a custom request field location for the Issues > Issue Properties > Update Issue Property method:

1. Go to the Edit Connector page of your Jira connector.

2. Under the Methods & Fields heading, select Issues > Properties > Update Issue Property.

3. Under the Request Fields heading, select the pink + button to add a method field.

4. Enter the following:
   ValueDescription
   Field LocationThe property key of the issue property.
   Display NameThe display name of the issue property in the Cyclr UI. Optional.
   DescriptionThe description of the issue property in the Cyclr UI. Optional.
   Data TypeThe data type of the issue property.

5. Select Create.

Map Get Issue Properties

To add a custom response field location for the Issues > Issue Properties > Get Issue Properties method:

1. Go to the Edit Connector page of your Jira connector.

2. Under the Methods & Fields heading, select Issues > Properties > Get Issue Properties.

3. Under the Response Fields heading, select the pink + button to add a method field.

4. Enter the following:
   ValueDescription
   Field LocationThe property key of the issue property.
   Display NameThe display name of the issue property in the Cyclr UI. Optional.
   DescriptionThe description of the issue property in the Cyclr UI. Optional.
   Data TypeThe data type of the issue property. This should match the data type used when creating the issue property.

5. Select Create.

Issues (Custom Fields - Object Name format: Project ID, Issue Type ID. (i.e. 10001,10009))

Using our Enhanced Objects article, the following steps are required to use Issues (Custom Fields - Object Name format: Project ID, Issue Type ID. (i.e. 10001,10009)) category:

To set up the Jira connector to use the Issues (Custom Fields - Object Name format: Project ID, Issue Type ID. (i.e. 10001,10009)) category, you need to do the following steps:

1. In the Cyclr console, go to Templates > Template Connectors and select the Edit Connector icon on the connector you want to use.

2. Find the Issues (Custom Fields - Object Name format: Project ID, Issue Type ID. (i.e. 10001,10009)) category, and select the Copy this Category to create a Custom Object Category button.
   Note: The copy button is only available for categories with the Category Customisation Enabled toggle on.

3. Enter the Project ID and Issue Type ID you need to create the custom category.

4. Select Copy.

Webhooks

In Jira, webhooks return all events by default. To trigger the webhook for specific events, you can use JQL to filter events.

Cyclr isn’t able to configure dynamic webhooks because workflow labels differ between instances of Jira and so a standard filter doesn't match each workflow. For example, the Closed status on a ticket can have different names, such as Completed, in separate instances.

There are Jira documentation guides that you can use to see how to use JQL and create a filtered webhook that works for your instance:

• JQL

• Webhooks