Jira

Comprehensive guide to using the Jira node in StackAI workflows, including top actions, input requirements, configurations, and output details.

What is Jira?

Jira is a powerful project management tool designed for issue and ticket tracking. The Jira node in StackAI allows you to automate the creation of Jira issues directly from your workflow, streamlining project management and team collaboration.

Establishing A Connection

  1. Click 'Create Connection' and give it a name you’ll recognize later (e.g., Sam's Connection).

  2. You’ll be redirected to the Atlassian website — sign in using your existing Jira account.

  3. Accept the requested permissions.

  4. Once redirected back to StackAI, open the dropdown menu under 'Select Connection' and select your newly created connection.

  5. Click the 'Test' button to verify the connection status is Healthy.

Action Summary Table

Action
Descriprion
Inputs
Outputs

Create Issue

Automatically create a new issue (ticket) in your Jira project.

Project ID, Issue Type ID, Summary, Description, Assignee ID, Parent Key, Priority ID, Labels, Due Date, Component, Custom Fields

Issue Key, Issue ID, Issue URL, Summary, Status, Message

Add Issue Attachment

Add one or more file attachments to a Jira issue

Jira Issue ID or Key, File Path

Issue ID or Key, Issue, Message

Add Issue Comment

Add a comment to an existing Jira issue.

Issue ID, Comment Text

Jira Comment ID, Jira Issue URL, Message

Link Jira Issues

Create a link between two Jira issues with an optional comment

Outward Issue Id Or Key, Inward Issue Id Or Key, Link Type, Comment Text

Outward Jira Issue, Inward Jira Issue, Jira Link Type, Operation Message

Get Issue

Retrieve details of a specific Jira issue.

Issue ID or Key, Fields to Include, Expand Options, Update History, Custom Field IDs, Include All Custom Fields

Issue ID or Key, Issue

Get Issue Comments

Retrieve comments for a Jira issue

Jira Issue ID or Key, Start At, Max Results, Order By, Expand

Issue ID or Key, Comments

Get Project

Get a specific Jira project by its ID or key

Project ID or Key, Expand

Project ID, Project Key, Project Name, Project Category, Project Description, Project Lead, Project Issue Types, Project URL, Project Keys

List Projects

Retrieve a list of all Jira projects accessible to your account.

Start At, Max Results, Order By, Query, Project Type, Project Status, Expand

Total Projects, Start At, Max Results, Is Last, Projects

Update Issue

Modify details of an existing Jira issue.

Issue ID or Key, Summary, Description, Labels Add, Labels Remove, Assignee, Priority, Custom Fields, Notify Users, Return Updated Issue

Issue ID, Issue, Message

Input Breakdowns

  • Assignee (ID) (string)

    • Description: Account ID of the user to assign the issue to. Use null or an empty string to unassign.

    • Where to find the Account ID:

      • In Jira Cloud, the Account ID is a unique identifier for each user. You can usually find it by:

        1. Going to the user's profile in Jira (the URL will contain the accountId parameter).

        2. Using the Jira API to list users, which will return their accountId.

        3. Sometimes, when assigning users in the Jira UI, you can inspect the network requests to see the accountId.

    • Example: 5b10a2844c20165700ede21g

  • Comment Text (string)

    • Description: The text content of the comment that will be added to the Jira issue.

    • Example: Linking this issue to track its dependency on the target issue

  • Component (IDs) (string)

    • Description: Components are sub-sections or parts of a Jira project. They are used to group issues within a project into smaller parts, such as features, teams, modules, or functional areas. Each component has a unique component ID within the project.

    • Where can you find components?

      In the Jira UI:

      • Go to your Jira project.

      • In the left sidebar, look for "Project settings" (or "Settings").

      • Click on "Components."

      • Here, you will see a list of all components for the project, along with their names and IDs (the ID is often visible in the URL when you click on a component, or you can get it via the API).

    • Example: ["10001", "10003"]

  • Custom Field IDs

  • Custom Fields (string)

    • Description: A JSON object containing custom field key-value pairs i.e. additional fields that your organization has configured to capture information beyond the standard fields (like summary, description, priority, etc.). These fields can be of various types (text, number, date, dropdown, user picker, etc.) and are used to tailor Jira issues to your team's specific needs.

    • Example: 

      "custom_fields": {
  "customfield_10010": "Affects all users in Europe",
  "customfield_10011": "High"
}

  • Description (string)

    • Description: A detailed description of the issue (supports Atlassian Document Format)

    • Example: Steps to reproduce the bug: 1. Log in to the app. 2. Click on the dashboard. 3. Observe the error message. Expected: Dashboard loads successfully. Actual: Error 500 is shown.

  • Due Date

  • Expand

  • Expand Options

  • Fields to Include

  • File Path

  • Include All Custom Fields

  • Inward Issue Id Or Key

  • Issue ID

  • Issue Type ID (string)

    • Description: Specifies what kind of issue you are creating in Jira. Common issue types include "Bug", "Task", "Story", "Epic", etc. Each type has its own workflow, fields, and purpose within your Jira project.

    • Where to Find It:

      • Jira Web Interface:

        1. Go to your Jira project.

        2. Click “Create” to open the new issue dialog.

        3. In the “Issue Type” dropdown, you’ll see the available types (e.g., Bug, Task, Story).

  • Jira Issue ID or Key

  • Labels

  • Labels Add

  • Labels Remove

  • Link Type

  • Max Results

  • Notify Users

  • Order By

  • Outward Issue Id Or Key

  • Parent Key (string)

    • Description: specify the key of a parent issue when you are creating a subtask in Jira.

      • It links the new subtask to an existing parent issue (like a Story, Task, or Bug).

      • For regular issues (not subtasks), you should leave this field blank.

    • Where to find it:

      • The parent key is the unique identifier of the parent issue, visible in Jira as the issue key (e.g., PROJ-123).

      • You can find it in the Jira issue list, in the issue’s URL, or at the top of the issue detail page.

    • Example: ENG-456

  • Priority

  • Priority ID (string)

    • Description: used to set the priority level of the Jira issue you are creating (such as "High", "Medium", "Low", etc.). The value must be the ID of the priority, not its name or label.

    • Where to find the priority ID:

      • In Jira, go to Issues → Priorities (admin section).

      • Each priority (like "High", "Medium", "Low") has a unique ID (e.g., "1", "2", "3", or sometimes a UUID).

      • You can also get the priority ID using the Jira API or by inspecting the page URL when editing a priority.

    • Example: 1

  • Project ID (string)

    • Description: A unique identifier for a Jira project.

    • Where to Find It:

      • Jira Web Interface:

        1. Go to your Jira dashboard.

        2. Click on "Projects" in the top menu and select your project.

        3. The project key is usually shown in the project’s URL and in the project header (e.g., "ABC" in "ABC-123").

        4. The project id (a numeric value) is not always visible in the UI, but the project key (a short code like "ABC") is commonly used and accepted in most API calls and integrations.

      • Jira URL Example:

        • If your project’s issues look like: https://yourcompany.atlassian.net/browse/ABC-123 Then "ABC" is the project key.

  • Project Status

  • Project Type

  • Query

  • Return Updated Issue

  • Start At

  • Summary (string)

    • Description: A concise summary or title for the Jira issue

    • Example: Add dark mode support to dashboard

  • Update History

Best Practices:

  • Always use the correct connection ID for your Jira account.

  • Ensure required fields are provided for each action.

  • Use outputs to connect Jira actions to downstream workflow nodes for further automation.

Advanced Settings

  • Retry on Failure: Enable retrying when the node execution fails

  • Fallback Branch: Create a separate branch that executes when this node fails, allowing you to handle errors gracefullyCreate a separate branch that executes when this node fails, allowing you to handle errors gracefully

PreviousHyperBrowserNextKnowledge Base

Last updated

Was this helpful?