Jira
This page provides information for connecting Appsmith to Jira, allowing you to create, update, and retrieve issues directly from your Jira workspace. With this integration, you can automate issue tracking, manage tasks, and interact with Jira projects.
Connect Jira
To connect Appsmith to Jira, you need to authenticate your Appsmith application with Jira. On the authentication page, log in with your Jira credentials and select the Jira app you want to connect.

Query Jira
The following section is a reference guide that provides a description of the available commands with their parameters to create Jira queries.
Create Issue
Creates a new issue in Jira. This command allows you to specify details such as project, issue type, and assignee while including a detailed description. Once the issue is successfully created, Jira returns an issue key (e.g., JIRA-123
) that can be used for further operations like updates or queries.
Summary string
A brief title describing the issue. This should be a concise and clear statement summarizing the problem or task.
Example: If you want to dynamically set the Summary from an Input widget, use:
{{summaryInput.text}}
Project string
The Jira project where the issue is created. This is the key or name of the project. If the project is not provided, Jira may use a default project if one is configured. If no default is set or the project key is invalid, the request fails with an error.
Example: If you want to dynamically set the project using Select widget:
{{projectSelect.selectedOptionValue}}
Issue Type string
Defines the type of issue being created, such as Bug, Task, or Story. If the issue type is not provided, Jira attempts to use the default issue type for the project. If no default is set or the provided issue type is invalid, the request fails with an error.
Example: If you want to fetch the issue type dynamically from a select widget:
{{issueTypeDropdown.selectedOptionValue}}
Jira Issue Status string
The initial status of the issue, based on the project's workflow. If the status is not provided, Jira assigns the default status for the selected issue type. If an invalid status is provided, the request fails with an error.
Assignee string
The email or account ID of the person assigned to the issue. If the assignee is not provided, Jira assigns the issue to the project’s default assignee. If an invalid assignee is provided, the request fails with an error.
Description string | JSON
A detailed description of the issue. Users can enter plain text or JSON-formatted content. If no description is provided, the issue is created without one.
Example (Plain Text): If you want to capture the description from a text area:
{{ TextArea1.text }}
Example (JSON): If you want to format the description dynamically:
{ "text": {{ TextArea1.text }} }
Additional Fields object
Extra fields that may be required based on your Jira configuration. If additional fields are required by the project but not provided, Jira may return an error.
Example: If you want to add labels dynamically:
{ "labels": {{ MultiSelect1.selectedOptionValues }} }
Update Issue
Updates an existing issue in Jira. This allows modifying properties such as summary, description, assignee, and additional fields. If the update is successful, Jira returns a confirmation response with the updated issue details. If the issue key is incorrect or required properties are missing, the request may fail with an error.
Issue Key string
The unique identifier of the issue to be updated. This can be found in the Jira UI or retrieved from a query response. If the issue key is not provided, the request fails with an error stating that the issue key is required.
Example: If you want to get the issue key from a table selection:
{{ Table1.selectedRow.issueKey }}
Summary string
A brief title describing the issue. If not provided, the existing summary remains unchanged.
Example: If you want to update the summary dynamically based on user input:
{{ Input1.text }}
Issue Type string
Defines the type of issue, such as Bug, Task, or Story. If not provided, the issue type remains unchanged. If an invalid issue type is entered, the request fails with an error.
Example: If you want to allow users to change the issue type using a dropdown:
{{ Select1.selectedOptionValue }}
Jira Issue Status string
Updates the status of the issue, such as "In Progress" or "Done." If the status is not provided, it remains unchanged. If an invalid status is entered, the request fails with an error.
Assignee string
The email or account ID of the person assigned to the issue. If not provided, the assignee remains unchanged. If an invalid assignee is entered, the request fails with an error.
Description string | JSON
A detailed description of the issue. If not provided, the existing description remains unchanged. Users can enter plain text or JSON-formatted content.
Additional Fields object
Extra fields that may be required based on your Jira configuration. If additional fields are required but not provided, Jira may return an error. Example: If you want to update priority dynamically:
{ "priority": {{ Select2.selectedOptionValue }} }
Get Issue by Key
Retrieves detailed information about a specific issue in Jira using its unique issue key. The response includes all issue properties such as summary, status, description, assignee, and additional fields. If the issue key is invalid or does not exist, Jira returns an error stating that the issue was not found.
Issue Key string
The unique identifier for the issue in Jira. The issue key consists of a project key followed by a number (e.g., "PROJ-123"). You can find the issue key:
- In the Jira UI, at the top of the issue page
- In the URL when viewing an issue (https://yourdomain.atlassian.net/browse/PROJ-123)
- From a query response when listing issues
- If the issue key is not provided, the request fails with an error stating that the issue identifier is required.
Example: If you want to fetch issue details based on a selected row in a table:
{{ Table1.selectedRow.issueKey }}