Jira Cloud steps
Flow Designer has a number of built-in steps to help you integrate Jira Cloud into your event management and incident response flows.
The following steps are available:
- Create Issue: automatically create a new issue in Jira Cloud, populating it with information from the alert or any previous steps in the flow.
- Update Issue: automatically update an issue as information about the problem or alert changes.
- Add Comment: add a comment to an existing issue in Jira.
- Create Issue in Project: automatically create a new issue in Jira Cloud based on the project and issue type.
- Modify Issue in Project: modify an existing Jira Cloud issue based on project and issue type.
Adding Jira Cloud steps to your flow
- To add a Jira Cloud step to your flow, go to the Apps panel in the palette, expand the Jira Cloud steps and drag the step you want onto the canvas.
- Connect the step to the previous step in the flow. This lets you access the alert properties and outputs of previous steps when configuring the inputs.
- Double-click the step to edit it, and use the Setup tab to configure the inputs, using plain text and input variables (or both). See the sections below for detailed information on the inputs for each step, including which are required. Some things to keep in mind:
- Jira Cloud or your organization might have certain requirements for the fields that get populated by these steps. Your Jira Cloud configuration might also be customized to allow different options besides those listed here.
- Certain input values must match case-sensitve values in Jira Cloud; if the input value does not match what Jira Cloud expects (for example, myname instead of MyName), it returns an error.
- On the Endpoint tab, select an existing endpoint or create a new endpoint with the following settings:
- Enter the base URL of your Jira Cloud instance (for example, https://jira.example.com).
- In Authentication, add the credentials of a user with permission to create and update issues. The username is whatever they use to log into Jira (often this is the user's email); for Password, use an API token generated for that user in Jira. Make sure Preemptive is selected before saving the endpoint configuration.
- For the Create Issue in Project step, select a project from the drop-down menu.
- For the Modify Issue in Project step, select a project and issue type from the drop-down menu.
Create Issue
Use the Create Issue step to automatically create a new issue in Jira Cloud, using the inputs to fill in the issue record. Map outputs from previous steps to the inputs; at runtime, the values in the inputs are used to fill in the issue record.
Create Issue inputs and outputs
Inputs
Inputs with an asterisk* are required.
|
Label API mapping |
Description |
|---|---|
|
Project Key* fields.project.key |
The Jira key of the parent project to assign the issue to. |
|
Issue Type* fields.issuetype.name |
The type of issue to create. This can be Task, Story, or Bug. You can find the Type in the issue details. |
|
Summary* fields.summary |
A brief summary of the issue. This becomes the title of the Jira Cloud record. |
|
Description fields.description |
The detailed description of the issue. |
|
Priority fields.priority.name |
Sets the importance of the issue in relation to other issues. This defaults to Medium if left blank. |
|
Labels fields.labels |
Additional labels to assign to the issue, entered as a comma-separated list. For example, to apply the labels for the Cats and Dogs releases, add release-Cats, release-Dogs. |
|
Assignee Key fields.assignee.name |
The Jira key of the person to assign the issue to (this can't be a group). Assignee Key defaults to unassigned if left blank. |
|
Reporter Key fields.reporter.name |
The Jira key of the person to record as the reporter of the issue. If left blank, Reporter Key defaults to the Project Lead set in your Jira Cloud instance. |
|
Environment fields.environment |
The environment the issue affects (for example, Chrome, iOS, etc.). |
Outputs
These outputs are available as inputs to steps further along the flow.
|
Label API mapping |
Description |
|---|---|
|
Issue ID id |
Unique ID assigned to the issue by Jira Cloud. Example: You can use this to identify the issue in an Update Issue step further down the flow. |
|
Issue Key key |
The key assigned to the issue by Jira Cloud. Example: You could use this as part of a channel name in a Create Channel or a Statuspage name in a Create Statuspage step further down the flow. |
Update Issue
Use the Update Issue step to automatically update an existing issue in Jira Cloud. Map outputs from previous steps to the inputs; at runtime, the values in the inputs are used to determine the issue to update and to update the record.
Update Issue inputs and outputs
Inputs
Inputs with an asterisk* are required.
|
Label API mapping |
Description |
|---|---|
|
Issue ID* issueIdOrKey |
The unique ID of the issue in Jira Cloud that you want updated by the flow. You can map this to the Issue ID from the output of a previous Create Issue step. |
|
Notify Users notifyUsers |
Sets if watchers of the issue are sent an email about the update. This must be true or false. |
|
Summary fields.summary |
A brief summary of the issue. This updates the title of the Jira Cloud record. |
|
Description fields.description |
The detailed description of the issue. |
|
Status fields.status.name |
The status you want to assign to the issue. Leave blank to keep the status as is. The transition from the current status to the target status must be configured in your Jira instance, and there can only be one transition path between the two statuses. For example, if the issue is currently at "To Do" and you want to set the status to "In Progress", To Do > In Progress must be a transition in your instance, and there can only be one path between "To Do" and "In Progress". An error is logged in the Activity panel if there are either no paths between the statuses or there are multiple paths. |
|
Priority fields.priority.name |
Sets the importance of the issue in relation to other issues. If left blank, the priority isn't changed. |
|
Labels fields.labels |
Labels to assign to the issue, entered as a comma-separated list. This overwrites the existing labels. For example, if the issue has the labels release-Cats and release-Dogs, and you populate this field with only release-Ferrets, the Cats and Dogs labels are removed and the Ferrets label is applied. To create a copy of the step that adds to the list of labels, see the knowledge base article Customize Jira Update Issue steps to add labels for instructions. |
|
Assignee Key fields.assignee.name |
The Jira key of the person to assign the issue to (this can't be a group). If left blank, the assignee isn't changed. |
|
Reporter Key fields.reporter.name |
The Jira key of the person to record as the reporter of the issue. If left blank, the reporter isn't changed. |
|
Environment fields.environment |
The environment the issue affects (for example, Chrome, iOS, etc.). |
Add Comment
Use the Add Comment step to add a comment to an existing issue in Jira Cloud. Map outputs from previous steps to the inputs; at runtime, the values in the inputs are used to determine the issue to comment on, and the content of the comment. You can format the comment using Jira's text formatting options - see this article from Atlassian for more information.
Add Comment inputs and outputs
Inputs
Inputs with an asterisk* are required.
|
Label API mapping |
Description |
|---|---|
|
Issue ID* issueIdOrKey |
The unique ID of the issue in Jira Cloud that you want to comment on. You can map this to the Issue ID from the output of a previous Create Issue step. |
|
Comment body |
The text of the comment you want to add. You can drag properties from previous steps to build out the comment content. |
|
Make Comment Internal properties |
When set to true, marks comments added to Jira Service Desk as "Internal"; i.e., the comments are not shared with customers. This must be true or false. |
Outputs
These outputs are available as inputs to steps further along the flow.
|
Label API mapping |
Description |
|---|---|
|
Comment ID id |
Unique ID assigned to the comment by Jira Cloud. Example: You can use this to identify the specific comment in another step further down the flow. |
Create Issue in Project
Use the Create Issue in Project step to automatically create a new issue in Jira Cloud, based on the project and issue type. Map outputs from previous steps to the inputs; at runtime, the values in the inputs are used to fill in the issue record. Certain input values must match case-sensitive values in Jira Cloud; if the input value does not match what Jira Cloud expects (for example, 'myname' instead of 'MyName'), it will return an error.
Create Issue inputs and outputs
Inputs
This step has no default inputs. Inputs required by Jira are automatically included, and you must provide values for them. Custom inputs are user-provided.
Outputs
These outputs are available as inputs to steps further along the flow.
|
Label |
Description |
|---|---|
| Issue ID | Unique identifier assigned to the issue in Jira Cloud. |
| Issue Key | Key assigned to the issue in Jira Cloud. |
| Issue Type | Type of issue in Jira Cloud. |
|
Project Name |
Name of the project in Jira Cloud where the issue was created. |
|
Project Key |
Key of the project in Jira Cloud where the issue was created. |
| Result | Result returned by Jira Cloud. Available value are: Success, Failure. |
Modify Issue in Project
Use the Modify Issue in Project step to update an issue in Jira Cloud, based on the project and issue type. Map outputs from previous steps to the inputs; at runtime, the values in the inputs are used to update the issue record. Certain input values must match case-sensitive values in Jira Cloud; if the input value does not match what Jira Cloud expects (for example, 'myname' instead of 'MyName'), it will return an error.
Modify Issue inputs and outputs
Inputs
Inputs with an asterisk* are required, and any fields you leave blank are not updated. Inputs required by Jira Cloud will automatically be included, and you must provide values for them. Custom inputs are user-provided.
|
Label API mapping |
Description |
|---|---|
|
Issue ID* issueIdOrKey |
Unique identifier assigned to the issue in Jira Cloud. |
Outputs
These outputs are available as inputs to steps further along the flow.
|
Label |
Description |
|---|---|
| Issue ID | Unique identifier assigned to the issue in Jira Cloud. |
| Issue Key | Key assigned to the issue in Jira Cloud. |
| Issue Type | Type of issue in Jira Cloud. |
| Issue URL | Direct link top the issue in Jira Cloud. The value is calculated using the endpoint URL and issue key. |
| Jira URL | Base URL of the Jira instance. |
|
Project Name |
Name of the project in Jira Cloud where the issue was created. |
|
Project Key |
Key of the project in Jira Cloud where the issue was created. |