---
title: Jira
slug: jira
description: The Jira integration creates Jira issues automatically from alerts, with optional Jira Service Management support. It supports custom labels, dynamic formatting, and additional custom fields.
docTags:
createdAt: 2023-10-10T20:03:49.801Z
---
You can send your Flare alerts directly to Jira. Here's how to configure Flare and receive data in your Jira Workspace. For detailed instructions, follow the storylane demo provided below.
:::Iframe{iframeHeight="0" code=""}
:::
# Creating a Jira Alert Channel
:::hint{type="info"}
You will need to be have an ADMIN role in your Flare organization in order to configure this Integration
:::
::::WorkflowBlock
:::WorkflowBlockItem
Go to the Integration Hub.
:::
:::WorkflowBlockItem
Click on Configure then Channel to create a new Channel.
:::
:::WorkflowBlockItem
Enter a name for your Channel.
:::
:::WorkflowBlockItem
Select "Jira" as Type.
:::
:::WorkflowBlockItem
Fill in the following information
1. **Server netloc:** the full domain of your jira server. Ex: `my-company.atlassian.net`
2. **Email**: The email of the account associated with the API token.
3. **API Token**: The API token (Create the API token here: [https://id.atlassian.com/manage-profile/security/api-tokens](https://id.atlassian.com/manage-profile/security/api-tokens))
4. **Space Key**: The project key is usually an UPPERCASE version of your project name. It can be found in the url of your project.
5. **Work Type**: The value provided should be an exact match with what was created in Jira.
6. **Labels**: These labels are added to every created issue. The labels support [Formatting (see below)](https://app.archbee.com/docs/ZrHXxu3Ros7EQ2RIFnJmk/VSkQyyh1iPmu_GqH4W-Ob#BL-SX).
:::
:::WorkflowBlockItem
Optionally, you can add additional custom fields to pass to Jira when creating issues. Each entry takes a field key and a value. Multiple fields can be added using the Add field button. This setting enables support for Jira Service Management. For more information, see [Jira Service Management](docId\:KxvmCnotECpsBlK_YPofr).
::Image[]{src="https://api.archbee.com/api/optimize/wtmLmyh6YG71yn5qVtkMM/Hry2qIDzbhvkQyPaGktz9_image.png" size="82" width="564" height="370" darkWidth="564" darkHeight="370" position="flex-start" showCaption="false"}
:::
:::WorkflowBlockItem
Use the Test Channel button to ensure that the connection is successful.
:::
:::WorkflowBlockItem
After a successful test, click the Create Alert Channel button to create the Channel.
:::
::::
:::hint{type="info"}
### Formatting
Dynamic formatting is supported for the following activity fields:
1. risk
2. source
3. type
Currently, formatting can only be used in the labels. For example, a label value of `flare-${risk}` can result in labels such as `flare-high`, `flare-critical`, etc.
::Image[]{src="https://api.archbee.com/api/optimize/wtmLmyh6YG71yn5qVtkMM/sdw9iE1QIR3GYjCvwbdIM_screenshot-at-2022-09-27-13-22-12.png" size="88" width="790" height="364" darkWidth="790" darkHeight="364" position="flex-start" showCaption="false"}
:::
***
# Viewing Alerts in Jira
Here is what a resulting Flare alert will look like in Jira. This example is from a Telegram chat message
***
# Jira Service Management
Flare supports Jira Service Management (JSM) Alert Channels. JSM requires a request type to be set when creating issues, which is configured using the Custom Fields option when setting up the Channel.
Each Custom Fields entry takes a field key and a value. For JSM, the field key is the custom field ID that corresponds to request type in Jira.
Follow these steps to find the correct values for your instance:
::::WorkflowBlock
:::WorkflowBlockItem
**Find the custom field ID**
- Go to the following URL, replacing `` with the ID of any existing issue in your project:
`https://.atlassian.net/rest/api/3/issue/?expand=names`
- In the response, extract the `customfield_XXXXX` key from `fields.issuetype.name` where the value is `Request Type.`
- Also note the \`id\` value of the issue, which you will need for the next step.
:::
:::WorkflowBlockItem
**Find the portal key and request type key**
- Go to the following URL, replacing `` with the \`id\` value from Step 1 above:
`https://.atlassian.net/rest/servicedesk/1/servicedesk/request//request-types`
- Extract the `portalKey` and `key` from the request type you would like to use with Flare.
- Combine them as `/` and enter those values as Custom Fields in the Jira Alert Channel.
:::
::::
For more detail on these API calls, see [Set the Request Type when creating an issue using REST API in JSM Cloud ](https://support.atlassian.com/jira/kb/set-the-request-type-when-creating-an-issue-using-rest-api-in-jsm-cloud/)in the Atlassian support documentation.
***
# Related Articles
:::CtaButton{label="Slack Integration" docId="kpbMB0w-L80be7nunpDrw" openInNewTab="true"}
:::
:::CtaButton{label="Splunk Integration" docId="ca9Opdt4_IFgL1pu8HBSU" openInNewTab="true"}
:::