Jira integration

Overview

Jira is Atlassian's issue tracking / project management platform. The Automize Jira connector covers the core issue lifecycle – create, read, update, transition (workflow), comment, search via JQL – plus the surrounding metadata you need: projects, users, fields, attachments.

• Regions: Jira Cloud is a single global platform – connector talks to your Atlassian site (yourcompany.atlassian.net). Server / Data Center versions use a different REST API surface (v2 vs v3) and would need a separate connector configuration. The current connector targets Jira Cloud.
• Plans: Free, Standard, Premium, Enterprise – all expose the REST API. Some fields (advanced workflows, custom field configurations) need Standard or above.

Setting up the connection

Auth type: OAuth 2.0 (Authorization Code).

1. Sign in at developer.atlassian.com → My Apps → Create app.
2. Add the Jira API permission scopes (see below).
3. Configure the Callback URL to the one shown in the Automize Jira connector dialog.
4. Copy Client ID + Client Secret from Settings.
5. In Automize, open Settings → Connectors → Jira → Add connection. Paste credentials, click Connect with Atlassian, pick the site to connect.

Scopes required:

• read:jira-work
• write:jira-work
• read:jira-user
• manage:jira-project
• offline_access

Find your credentials at https://developer.atlassian.com/console/myapps/.

Rate limits

Jira Cloud enforces per-tenant + per-app rate limits, generally ~10 requests/sec/app for reads and lower for writes. The connector retries 429 with the Retry-After header. For bulk operations (import 1000+ issues), use Bulk Create + Bulk Get – they take an array per call.

Data model

Hierarchy:

    Site (atlassian.net) ─┬─ Project ─┬─ Issue Types (Story, Bug, Task, Epic, Sub-task)
                          │           ├─ Issues
                          │           │      ├─ Comments
                          │           │      ├─ Attachments
                          │           │      ├─ Worklogs
                          │           │      ├─ Sub-tasks
                          │           │      └─ Linked Issues
                          │           ├─ Components
                          │           └─ Versions
                          └─ Users (via Atlassian account)

Issues are referenced by key (PROJ-123) or numeric id. Custom fields use
customfield_xxxxx IDs – discover via Get Issue + look at the response.

Available operations

29 operations available. Click any row to jump to its detail.

Operations

Add attachment

Add an attachment to a Jira issue.

Add comment

Add a comment to a Jira issue.

Tips

• body in ADF (Atlassian Document Format) – rich content. Plain text body works if you pass it as a doc with one paragraph node.

Add Watcher

Add a watcher to an issue

Add worklog

Log time against a Jira issue.

Tips

• timeSpent format: '2h 30m'. Or pass timeSpentSeconds as an integer.

Assign issue

Assign a Jira issue to a user.

Tips

• Pass account_id of the assignee. Use null to unassign, -1 for 'Automatic'.

Create issue

Create a new Jira issue with project, summary, type, and description.

Tips

• Required body: fields:{project:{key:'PROJ'}, summary:'...', issuetype:{name:'Task'}}.
• Custom fields by ID: fields.customfield_10101 = ...
• Returns key + id of the new issue.

Errors

• Field 'Project' is required – fields.project must include either key or id.
• Invalid issuetype – Issue type name doesn't exist in this project.

Delete comment

Delete a comment from a Jira issue.

Tips

• Soft-delete – Jira keeps history but removes from view.

Delete issue

Delete a Jira issue by key.

Tips

• Hard-deletes the issue. Sub-tasks delete with the parent unless deleteSubtasks=false.

Get issue

Get a Jira issue by key or ID.

Tips

• issue_key (PROJ-123) or numeric ID.
• expand=names returns field-name → field-ID map for custom fields.
• expand=changelog returns issue history.

Get Project

Get a project by key or ID

Tips

• project_id or project_key. Returns components, issue types, versions, lead user.

Get sprint

Get a Jira sprint by ID.

Get transitions

Get available transitions for a Jira issue.

Link issues

Create a link between Jira issues.

Tips

• type: 'blocks', 'relates to', 'is duplicated by', etc. (must match a Link Type configured in your Jira).

List boards

List Jira boards.

No input parameters.

List comments

List comments on a Jira issue.

Tips

• Newest first by default. Use orderBy=created for oldest first.

List Components

List components for a project

Tips

• Project components. Useful for routing issues by area.

List Fields

List all fields (standard and custom)

No input parameters.

Tips

• Returns all field IDs incl. custom fields. Use to map customfield_xxxxx to human-readable names.

List issue types

List issue types for a Jira project.

No input parameters.

List priorities

List Jira priorities.

No input parameters.

List projects

List all accessible Jira projects.

No input parameters.

Tips

• Returns projects the user can browse.

List sprint issues

List issues in a Jira sprint.

List sprints

List sprints in a Jira agile board.

List statuses

List Jira statuses.

No input parameters.

List Versions

List versions for a project

Tips

• Project versions (releases). Useful for filtering issues by fixVersion.

List worklogs

List worklogs on a Jira issue.

Tips

• Time tracking entries. Returns time spent + author + dates.

JQL search

Search Jira issues using JQL with auto-pagination.

Transition issue

Transition a Jira issue to a new status.

Tips

• transition.id from List Transitions.
• Some transitions require fields (e.g. resolution on 'Done'). Pass fields:{} alongside.

Update comment

Update a comment on a Jira issue.

Tips

• Edit your own comments. Admins can edit others'.

Update issue

Update a Jira issue's fields.

Tips

• PUT replaces fields you send; PATCH-style via update operator (set, add, remove).
• Updates don't trigger workflow transitions – use Transition Issue for status changes.

FAQ

How do I find custom field IDs?

Call List Fields. Each custom field appears as customfield_xxxxx with its human-readable name. Or Get an Issue with expand=names – the response includes a names map.

Server / Data Center – supported?

This connector targets Jira Cloud (REST API v3). Server/DC uses REST API v2 with different auth (PAT) and slight payload differences. Use a separate self-hosted-Jira connection if needed.

Why does Transition Issue fail with 'Resolution is required'?

Some transitions (typically 'Done') require setting a resolution. Pass fields:{resolution:{name:'Done'}} in the same call.

ADF (Atlassian Document Format) – how do I send plain text in a comment?

ADF wraps text in nodes. For 'Hello world' as a comment, body: {type:'doc',version:1,content:[{type:'paragraph',content:[{type:'text',text:'Hello world'}]}]}.

User lookup – username doesn't work.

Jira Cloud deprecated username + key in 2019. Use accountId (Atlassian account ID) everywhere. Find it via User search or Get User by email.

Related connectors

• Github
• Gitlab
• Linear
• Asana