Jira — Configuration

Authentication Properties (All Operations)

Property	Required	Description
`InstanceUrl`	Required	Your Jira base URL with no trailing slash. For Jira Cloud: `https://yourorg.atlassian.net`. For Jira Server: `https://jira.yourcompany.com`.
`Email`	Required	The email address of the Atlassian account whose API token is being used. For Jira Server, this is the Jira username.
`ApiToken`	Required	Jira API Token (not your Atlassian password). Generate at `id.atlassian.com/manage-profile/security/api-tokens`. Store in BizFirst Credentials Manager.

issue/create

Property	Required	Description
`ProjectKey`	Required	The project key where the issue will be created (e.g. `ENG`, `OPS`, `INFRA`).
`IssueType`	Required	Issue type name. Standard types: `Bug`, `Task`, `Story`, `Epic`. Subtasks use `Subtask`. Custom issue types are also supported — use the exact name as configured in the project.
`Summary`	Required	The issue title or summary line. Supports BizFirst expressions.
`Description`	Optional	Issue description. Accepts plain text or Atlassian Document Format (ADF) JSON for rich formatting with paragraphs, code blocks, bullet lists, and more. See ADF note below.
`Priority`	Optional	Priority name. Standard values: `Highest`, `High`, `Medium`, `Low`, `Lowest`.
`Assignee`	Optional	Jira account ID of the user to assign the issue to. Obtain from `user/search`. Not the username or email — must be the account ID string.
`Labels`	Optional	Array of label strings to apply to the issue. Labels are created automatically if they do not exist. Example: `["production", "critical", "payment-service"]`.
`Components`	Optional	Array of component name strings. Components must already exist in the project. Example: `["Backend", "API Gateway"]`.
`ParentIssueKey`	Optional	Issue key of the parent issue. Required when creating a Subtask. For Epics linking Stories, use the Epic Link custom field via `CustomFields` instead.
`CustomFields`	Optional	JSON object of custom field values keyed by custom field ID (e.g. `customfield_10014`). Values must match the field's expected format. Use `issue/get` on an existing issue to discover custom field IDs.

issue/get

Property	Required	Description
`IssueKey`	Required	The full Jira issue key in `PROJECT-NUMBER` format, e.g. `ENG-142`. Supports expressions.

issue/getMany

Property	Required	Description
`Jql`	Required	JQL (Jira Query Language) query string. See JQL reference section below for syntax and examples.
`MaxResults`	Optional	Integer. Maximum issues to return. Default: `50`. Max: `100` per request.
`Fields`	Optional	Comma-separated list of field names to include in the response. Reduces response size. Example: `"summary,status,assignee,priority"`. Omit for all fields.

issue/update

Property	Required	Description
`IssueKey`	Required	The key of the issue to update (e.g. `ENG-142`).
`Summary`	Optional	New summary (title) for the issue.
`Description`	Optional	New description. Accepts plain text or ADF JSON. Replaces the existing description entirely.
`Priority`	Optional	New priority name.
`Assignee`	Optional	Account ID of the new assignee. Pass `null` to unassign.
`Labels`	Optional	Full replacement array of labels. This replaces all existing labels.
`CustomFields`	Optional	JSON object of custom field updates.

issue/delete

Property	Required	Description
`IssueKey`	Required	The key of the issue to delete.
`DeleteSubtasks`	Optional	Boolean. Default: `false`. When `true`, deletes all subtasks of the issue along with the parent. Required if the issue has subtasks — otherwise the delete will fail with an error.

issue/addComment

Property	Required	Description
`IssueKey`	Required	The key of the issue to comment on.
`Comment`	Required	Comment body. Accepts plain text string or Atlassian Document Format (ADF) JSON for rich-text comments. ADF allows panels, code blocks, mentions, tables, and inline formatting.

issue/transition

Property	Required	Description
`IssueKey`	Required	The issue key to transition.
`TransitionName`	Required	The name of the workflow transition to execute. Example: `"In Progress"`, `"In Review"`, `"Done"`. The node resolves the transition name to its ID automatically. Use `project/getStatuses` to discover available transition names.

project/get & project/getStatuses

Property	Required	Description
`ProjectKey`	Required	The project key to retrieve (e.g. `ENG`).

project/getMany

Property	Required	Description
`MaxResults`	Optional	Integer. Maximum number of projects to return. Defaults to all accessible projects.

user/get

Property	Required	Description
`AccountId`	Required	The Jira user account ID (UUID-like string). Obtain from `user/search` or from the `assignee.accountId` field on any issue.

user/search

Property	Required	Description
`Query`	Required	Search string — matches against user display name, username, and email address. Returns all matching users with their account IDs.

sprint/create

Property	Required	Description
`BoardId`	Required	The ID of the Jira Software board to create the sprint on. Found in the board URL: `.../boards/BOARD_ID`.
`Name`	Required	Sprint name. Example: `"Sprint 42"` or `"{{ vars.sprint_name }}"`.
`StartDate`	Optional	ISO 8601 date-time for sprint start. Example: `"2026-06-02T09:00:00.000Z"`.
`EndDate`	Optional	ISO 8601 date-time for sprint end.
`Goal`	Optional	Sprint goal text. Visible on the sprint board and in reports.

sprint/get

Property	Required	Description
`SprintId`	Required	The numeric sprint ID. Obtain from `sprint/getMany` or from the sprint URL.

sprint/getMany

Property	Required	Description
`BoardId`	Required	The ID of the board whose sprints to list.
`State`	Optional	Filter by sprint state. One of: `active`, `closed`, `future`. Omit to return all sprints.

sprint/addIssues

Property	Required	Description
`SprintId`	Required	The numeric ID of the sprint to add issues to.
`IssueKeys`	Required	Array of issue key strings to move to the sprint. Example: `["ENG-101", "ENG-102", "ENG-105"]`.

JQL Reference

JQL (Jira Query Language) is used in issue/getMany. It supports a rich set of operators and functions for querying any Jira field:

Example JQL	What It Finds
`project = ENG AND status = "In Progress"`	All in-progress issues in the ENG project
`issuetype = Bug AND priority = High AND created >= -7d`	High-priority bugs created in the last 7 days
`assignee = currentUser() AND status != Done`	All open issues assigned to the API token owner
`sprint in openSprints() AND status = "To Do"`	Unstarted issues in any active sprint
`fixVersion = "v2.1.0" AND issuetype = Story`	All stories targeted for a specific release
`labels = "production" AND status changed to "Done" after "2026-05-01"`	Production issues resolved after a date

Atlassian Document Format (ADF)

The Description field in issue/create and issue/update, and the Comment field in issue/addComment, accept Atlassian Document Format (ADF) for rich-text content:

{
  "version": 1,
  "type": "doc",
  "content": [
    {
      "type": "paragraph",
      "content": [
        { "type": "text", "text": "Error occurred in " },
        { "type": "text", "text": "payment-service", "marks": [{ "type": "strong" }] },
        { "type": "text", "text": " at 14:32 UTC." }
      ]
    },
    {
      "type": "codeBlock",
      "attrs": { "language": "text" },
      "content": [
        { "type": "text", "text": "ConnectionTimeoutException: gateway timed out after 30s" }
      ]
    }
  ]
}

For plain-text descriptions and comments, pass a simple string instead of ADF JSON. The node detects the type automatically. Use ADF when you need bold text, code blocks, bullet lists, panels, or @mentions in issue descriptions or comments.