Jira
API actions for the Jira integration.
Jira
Connect your Jira account to browse projects and create, update, and search issues.
Add a comment to a Jira issue
Post a comment on a Jira issue.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key | string | Yes | Key of the Jira issue to comment on, for example PROJ-123. |
body | string | Yes | Text of the comment to post. |
Response
{
"comment": {
"body": "Sample text content",
"id": "abc123xyz789",
"issue_key": {
"id": "abc123",
"name": "Sample"
}
}
}Create a Jira issue
Create a new Jira issue with a title and an optional description, priority, and assignee.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project_key | string | Yes | Key of the Jira project to create the issue in, for example PROJ. |
summary | string | Yes | Title of the issue. |
description | string | No | Longer description of the issue. Supports Jira's text formatting. |
issue_type | string | No | Type of issue to create, for example Task, Bug, or Story. |
priority | string | No | Name of the priority to set, for example High or Low. |
assignee_account_id | string | No | Account ID of the person to assign the issue to. |
Response
{
"issue": {
"id": "abc123xyz789",
"key": "example_value",
"self": "example_value"
}
}Get a Jira issue
Look up a Jira issue's details, including its title and status.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key | string | Yes | Key of the Jira issue to look up, for example PROJ-123. |
Response
{
"issue": {
"id": "abc123xyz789",
"key": "example_value",
"status": {
"id": "1",
"name": "In Progress"
},
"summary": "example_value"
}
}List Jira projects
List the Jira projects your connected account can access.
Response
{
"projects": [
{
"id": "proj123",
"key": "PROJ",
"name": "Development"
}
]
}List transitions for a Jira issue
List the status changes (transitions) available for a Jira issue based on its current status.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key | string | Yes | Key of the Jira issue to get transitions for, for example PROJ-123. |
Response
{
"transitions": [
{
"id": "21",
"name": "In Progress",
"to": {
"id": "3",
"name": "In Progress"
}
}
]
}Search Jira issues
Find Jira issues using a Jira search query (JQL).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
jql | string | Yes | What to search for, written as a Jira search query (JQL). For example: project = PROJ AND status = 'In Progress'. |
max_results | number | No | Maximum number of results to return, from 1 to 100. |
next_page_token | string | No | To get more results, enter the next page token returned by the previous search. |
Response
{
"issues": [
{
"id": "item123",
"key": "PROJ-1",
"status": {
"id": "1",
"name": "To Do"
},
"summary": "Sample Task"
}
]
}Move a Jira issue to a new status
Move a Jira issue to a new status by applying a transition ID.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key | string | Yes | Key of the Jira issue to move, for example PROJ-123. |
transition_id | string | Yes | ID of the transition to apply. Use the list transitions action to find the available IDs. |
Response
{
"issue_key": {
"id": "abc123",
"name": "Sample"
},
"transition_id": {
"id": "abc123",
"name": "Sample"
}
}