Jira

Manage issues in Jira

Actions

Create Incident Create a Jira Service Management incident via the Incidents API

Create Issue Create a new issue in Jira

Delete Incident Delete a Jira Service Management incident by issue id or issue key

Delete Issue Delete a Jira issue

Get Incident Fetch a Jira Service Management incident by issue id or issue key

Get Issue Retrieve a Jira issue by its key

Update Issue Update fields on a Jira issue

Instructions

To connect Jira to SuperPlane:

Open Atlassian API tokens.
Click Create API token, give it a recognizable label, and copy the generated token.
Paste your Jira Site URL into SuperPlane. For Jira Cloud, this usually looks like https://your-domain.atlassian.net.
Paste the Atlassian account Email that owns the API token.
Paste the generated API Token.

Create Incident

The Create Incident component opens a new incident in Jira Service Management.

Use Cases

Alert-driven incidents: Create an incident from a monitoring or ticketing workflow
Cross-tool orchestration: Open a JSM incident when another system reports an outage
Responder assignment: Pass responders and other fields supported by your service desk

Configuration

Service desk: Choose a Jira Service Management service desk (from your site via the JSM API)
Request type: Choose a request type on that service desk (lists after a service desk is selected)
Summary (required): Short title for the incident; sent as the Jira summary field (Jira requires this). You can set this directly, or supply summary only via Additional fields.
Description (optional): Plain text stored as Jira description (Atlassian Document Format).
Due date (optional): Jira duedate (use your site date format, typically YYYY-MM-DD).
Priority (optional): Jira priority name (for example Medium).
Impact (optional): Impact level from your Jira request type (options load after service desk and request type are selected).
Urgency (optional): Urgency level from your Jira request type (options load after service desk and request type are selected).
Original estimate (optional): Jira timetracking.originalEstimate (for example 2h, 1d).
Custom fields (optional): List of Jira field ids with JSON values—for affected services, pending reason, or any customfield_*; the value must be valid JSON (object or string) as Jira expects for that field type.
Additional fields (optional): JSON object merged into the API fields map (same pattern as other integrations such as Honeycomb Fields JSON).
Update (optional): JSON object for the Incidents API update property.
Alert IDs (optional): List of alert id strings to associate with the incident.

Output

Returns id (numeric issue id), key (e.g. ITSM-30), and self (issue REST URL) from the create response.

Notes

Requires a Jira Cloud site with Jira Service Management and a synced SuperPlane Jira integration (cloud id is resolved automatically).
Request types must belong to Jira’s Incident management work category; other request types (for example service requests) are hidden from the picker when Jira returns a practice field on request types. If your site uses an unrecognized practice value, contact support with a sample from GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId} with expand=practice.
Field ids such as responders are site-specific; use Custom fields or Additional fields with values that match your JSM configuration.

Example Output

{
  "data": {
    "id": "10050",
    "key": "ITSM-30",
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10050"
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "jira.incident.created"
}

Create Issue

The Create Issue component creates a new issue in Jira.

Use Cases

Task creation: Automatically create tasks from workflow events
Bug tracking: Create bugs from error detection systems
Feature requests: Generate feature request issues from external inputs

Configuration

Project: The Jira project to create the issue in
Issue Type: The type of issue (scoped to the chosen project)
Summary: The issue summary/title
Description: Optional description text
Assignee: Optional Jira user to assign the issue to
Status: Optional initial status. Jira always creates issues in the workflow’s initial state, so when this is set the component executes a transition immediately after create. The status must be reachable via a transition from the initial state.

Output

Returns the created issue including:

id: The issue ID
key: The issue key (e.g. PROJ-123)
self: API URL for the issue
fields: Full issue fields after any status transition

Example Output

{
  "data": {
    "fields": {
      "assignee": {
        "accountId": "5b10a2844c20165700ede21g",
        "displayName": "Alice Example",
        "emailAddress": "[email protected]"
      },
      "created": "2026-01-19T12:00:00.000+0000",
      "issuetype": {
        "name": "Bug"
      },
      "labels": [
        "backend",
        "p1"
      ],
      "priority": {
        "name": "High"
      },
      "project": {
        "id": "10000",
        "key": "PROJ",
        "name": "Proj"
      },
      "reporter": {
        "accountId": "5b10ac8d82e05b22cc7d4ef5",
        "displayName": "Bob Example"
      },
      "status": {
        "name": "To Do",
        "statusCategory": {
          "key": "new",
          "name": "To Do"
        }
      },
      "summary": "Investigate timeout on checkout flow",
      "updated": "2026-01-19T12:00:00.000+0000"
    },
    "id": "10001",
    "key": "PROJ-123",
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "jira.issue"
}

Delete Incident

The Delete Incident component removes an incident from Jira Service Management.

Use Cases

Automated cleanup: Remove incidents created during tests or erroneous automation
Lifecycle workflows: Delete when a duplicate or mistaken incident is closed upstream

Configuration

Project (optional): Narrows the issue picker to one Jira project (up to 500 most recently updated issues in that project).
Issue: The incident issue to delete (issue key from Jira search).

Output

Confirms deletion with deleted set to true.

Example Output

{
  "data": {
    "deleted": true
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "jira.incident.deleted"
}

Delete Issue

The Delete Issue component permanently removes an issue from Jira.

Use Cases

Cleanup: remove placeholder or duplicate issues created by automated flows
CRUD completion: pair with create/update flows for full lifecycle management

Configuration

Project: The Jira project the issue belongs to
Issue Key: The issue key (e.g. PROJ-123)
Delete Subtasks: Also delete the issue’s subtasks (Jira returns an error if subtasks exist and this is false)

Output

Returns the deleted issue’s id and key, plus deleted: true.

Example Output

{
  "data": {
    "deleted": true,
    "id": "10001",
    "key": "PROJ-123"
  },
  "timestamp": "2026-01-19T13:00:00Z",
  "type": "jira.issueDeleted"
}

Get Incident

The Get Incident component returns incident details from Jira Service Management.

Use Cases

Enrichment: Load incident DTO after an issue webhook or workflow step
Status checks: Read priority, status, responders, and affected services from JSM

Configuration

Project (optional): When set, the issue picker lists issues in that project (by project key), paged from Jira search (up to 500, most recently updated first). Leave empty to list issues updated in roughly the last 90 days across projects you can access (same cap and ordering).
Issue: Choose an issue by key (from Jira search). The stored value is the issue key; numeric ids still work when they are saved as the issue reference.

Output

Payload type jira.incident.fetched with the incident object returned by Atlassian (summary, reporter, priority, status, responders, etc.).

Example Output

{
  "data": {
    "priority": {
      "id": "1",
      "name": "High"
    },
    "summary": "Example incident"
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "jira.incident.fetched"
}

Get Issue

The Get Issue component retrieves a Jira issue and its fields for downstream routing and inspection.

Use Cases

Routing decisions: inspect status, assignee, labels, or priority before branching
Escalation context: include issue details in notifications or downstream tickets
Cross-tool sync: enrich workflows that mirror Jira state into other systems

Configuration

Project: The Jira project the issue belongs to
Issue Key: The issue key (e.g. PROJ-123)
Expand: Optional comma-separated Jira expand values, such as renderedFields,names

Output

Returns the Jira issue object including id, key, self and the full fields map.

Example Output

{
  "data": {
    "fields": {
      "assignee": {
        "accountId": "5b10a2844c20165700ede21g",
        "displayName": "Alice Example",
        "emailAddress": "[email protected]"
      },
      "created": "2026-01-19T12:00:00.000+0000",
      "issuetype": {
        "name": "Bug"
      },
      "labels": [
        "backend",
        "p1"
      ],
      "priority": {
        "name": "High"
      },
      "project": {
        "id": "10000",
        "key": "PROJ",
        "name": "Proj"
      },
      "reporter": {
        "accountId": "5b10ac8d82e05b22cc7d4ef5",
        "displayName": "Bob Example"
      },
      "status": {
        "name": "In Progress",
        "statusCategory": {
          "key": "indeterminate",
          "name": "In Progress"
        }
      },
      "summary": "Investigate timeout on checkout flow",
      "updated": "2026-01-19T12:30:00.000+0000"
    },
    "id": "10001",
    "key": "PROJ-123",
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "jira.issue"
}

Update Issue

The Update Issue component updates fields on an existing Jira issue.

Use Cases

Automated triage: change status, priority, or assignee when a workflow processes the issue
Cross-tool sync: mirror state from another system into Jira
Bulk relabeling: apply labels based on workflow inputs

Configuration

Project: The Jira project the issue belongs to
Issue Key: The issue key (e.g. PROJ-123)
Summary, Description, Issue Type, Assignee, Priority, Labels: Optional fields to update. At least one must be supplied.
Notify Users: Whether to send notification emails (defaults to Jira’s behaviour)

Output

Returns the updated Jira issue as fetched after the update.

Example Output

{
  "data": {
    "fields": {
      "assignee": {
        "accountId": "5b10a2844c20165700ede21g",
        "displayName": "Alice Example"
      },
      "issuetype": {
        "name": "Bug"
      },
      "labels": [
        "backend",
        "p1",
        "in-review"
      ],
      "priority": {
        "name": "Medium"
      },
      "project": {
        "id": "10000",
        "key": "PROJ",
        "name": "Proj"
      },
      "status": {
        "name": "In Review"
      },
      "summary": "Investigate timeout on checkout flow (updated)",
      "updated": "2026-01-19T12:45:00.000+0000"
    },
    "id": "10001",
    "key": "PROJ-123",
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
  },
  "timestamp": "2026-01-19T12:45:00Z",
  "type": "jira.issue"
}