Jira

Description

Integration with Jira Cloud through the Atlassian REST API v3. The family covers the issue lifecycle: create, read, update fields, search with JQL, add comments and move an issue across the board with a transition.

Authentication is handled by the credentials module (provider jira), using Basic auth built from your account email and an API token. The node appends /rest/api/3 to your site URL automatically, so you only store the base domain.

Operations

Create Issue Create an issue in a project (POST /issue).

Get Issue Read an issue by its key (GET /issue/{key}).

Update Issue Update issue fields (PUT /issue/{key}).

Search Issues Search with JQL (POST /search/jql).

Transition Issue Change status by transition id or name.

Add Comment Comment on an issue (POST /issue/{key}/comment).

Nodes at a glance

Node	Internal name	HTTP call
Jira: Create issue	`jiraCreateIssue`	`POST /issue`
Jira: Get issue	`jiraGetIssue`	`GET /issue/{key}`
Jira: Update issue	`jiraUpdateIssue`	`PUT /issue/{key}`
Jira: Search (JQL)	`jiraSearchIssues`	`POST /search/jql`
Jira: Transition	`jiraTransitionIssue`	`POST /issue/{key}/transitions`
Jira: Add comment	`jiraAddComment`	`POST /issue/{key}/comment`

Configuration

Every node in the family shares one parameter; the rest are documented on each operation page.

Parameter	Type	Required	Description
credentials_id	credentials	Yes	Jira credential (provider `jira`)

Credentials

Provider: jira. Create it in Credentials → Add → Jira (Atlassian).

Field	Description
`base_url`	Your Atlassian site URL, no trailing slash (e.g. `https://your-domain.atlassian.net`). The node appends `/rest/api/3`.
`email`	Email of the Atlassian account that owns the API token.
`api_token`	Token created at id.atlassian.com → Security → API tokens. Masked in logs.
`timeout`	Optional. Request timeout in milliseconds (default `20000`).

Authentication is Basic — the node builds Basic base64(email:api_token). The Test button calls GET /myself and returns the display name of the authenticated account.

Important: ADF rich text

Jira’s API v3 requires rich-text fields (description and comment bodies) to be sent in Atlassian Document Format — a JSON structure, not a plain string. The nodes convert your text to ADF automatically: you type normal text (line breaks become separate paragraphs) and the node builds the JSON.

This applies to description in Create issue, description inside the fields JSON of Update issue, and comment in Add comment.

Output

Each node returns the Jira payload in data, plus a _meta object with the module version and timing:

{
  "data": { "id": "10042", "key": "OPS-123", "self": "https://your-domain.atlassian.net/rest/api/3/issue/10042" },
  "_meta": { "moduleVersion": "1.0.0", "success": true, "key": "OPS-123", "id": "10042", "totalMs": 412 }
}

On failure the node stops the branch and returns an error object instead:

{
  "data": {},
  "error": { "message": "Field 'summary' is required.", "type": "validation", "status": 400 }
}

API Used

Jira Cloud platform REST API v3 — https://developer.atlassian.com/cloud/jira/platform/rest/v3/

Notes

Dynamic variables such as {{data.subject}} are resolved in the text parameters: project_key, summary, description, issue_key, jql, transition and comment. They are not resolved inside JSON parameters (extra_fields, fields) nor in the comma-separated field lists.
Retries are automatic and capped at 3 attempts with exponential backoff for network errors, timeouts, 429 (honouring Retry-After) and 5xx. Validation, 404 and authentication errors are not retried.
The default request timeout is 20 seconds; raise it with the timeout field in the credential.
The API token is never written in full to the logs — only a masked form such as abcd…wxyz.