Skip to main content

Jira Service Management Component

Interact with the Jira Service Management API to manage service requests, issues, request types, queues, and approvals.

Component key: jira-service-management · Changelog ↓

Description

Jira Service Management is an IT service management (ITSM) platform from Atlassian for managing service requests, incidents, and changes. This component allows managing service desks, requests, request types, queues, approvals, organizations, and customers within Jira Service Management. It also supports Operations (Ops) alerts and schedules, Assets / CMDB objects and schemas, and Integration Events for alert ingestion. Polling triggers are included for new service requests and new Ops alerts.

API Documentation

This component was built using the following Atlassian APIs:

Connections

Basic Authentication

key: jsmBasic

To authenticate with Jira Service Management using Basic Authentication, an email address and an API token are required.

Prerequisites

  • A Jira Cloud instance with Jira Service Management enabled
  • An Atlassian account with appropriate permissions

Setup Steps

  1. Navigate to Atlassian Account API Tokens
  2. Click Create API token
  3. Enter a label for the token and click Create
  4. Copy the generated API token value

For more information on generating API tokens, refer to the Atlassian documentation.

Configure the Connection

Create a connection of type Basic Authentication and configure the following fields:

  • For Username, enter the email address associated with the Atlassian account
  • For API Key, enter the API token generated in the previous step
  • For Host, enter the Atlassian site hostname without https:// (e.g., example-company.atlassian.net)
InputNotesExample
Host

The Atlassian site hostname (without https://).

your-company.atlassian.net
API Key

The Atlassian API token. Generate one at Atlassian API Tokens.

ATATT3xFfGF0T8gK8Example1234567890abcdefGHIJKLMNOP
Username

The Atlassian account email address used for authentication.

john.doe@example.com

OAuth 2.0

key: jsmOAuth2

To connect to Jira Service Management using OAuth 2.0, create and configure an OAuth 2.0 (3LO) application in the Atlassian Developer Console.

Prerequisites

Setup Steps

  1. Navigate to the Atlassian Developer Console and click Create then OAuth 2.0 integration
  2. Enter a name for the application and click Create
  3. In the left sidebar, click Authorization and then click Add next to OAuth 2.0 (3LO)
  4. Enter the OAuth 2.0 callback URL as the Callback URL: https://oauth2.prismatic.io/callback
  5. Click Save changes
  6. In the left sidebar, click Permissions and configure the required scopes for Jira Service Management access
  7. In the left sidebar, click Settings to find the Client ID and Secret values

Refer to the Atlassian OAuth 2.0 (3LO) documentation for detailed setup instructions.

Configure the Connection

Create a connection of type OAuth 2.0 and configure the following fields:

  • For Authorize URL, the default value is pre-configured for Atlassian Cloud APIs:
    https://auth.atlassian.com/authorize?audience=api.atlassian.com&prompt=consent
  • For Token URL, the default value is:
    https://auth.atlassian.com/oauth/token
  • For Scopes, the default value covers Service Desk requests, Ops alerts and configuration, and Assets / CMDB objects, schemas, and types:
    read:servicedesk-request write:servicedesk-request manage:servicedesk-customer read:jira-user
    read:ops-alert:jira-service-management write:ops-alert:jira-service-management delete:ops-alert:jira-service-management
    read:ops-config:jira-service-management write:ops-config:jira-service-management delete:ops-config:jira-service-management
    read:cmdb-object:jira write:cmdb-object:jira delete:cmdb-object:jira
    read:cmdb-schema:jira write:cmdb-schema:jira delete:cmdb-schema:jira
    read:cmdb-type:jira write:cmdb-type:jira delete:cmdb-type:jira
    read:cmdb-attribute:jira offline_access
    Existing connections created before the Ops and Assets scopes were added must be reauthorized to use those actions. Trim the list to only the scopes the integration needs. Refer to the Atlassian scopes documentation for additional scope information.
  • Enter the Client ID and Client Secret from the application settings in the Developer Console
  • Optionally, enter the Atlassian Site Name if the Atlassian account has access to multiple Jira sites (e.g., example-company.atlassian.net). If left blank, the connection uses the first accessible site.
InputNotesExample
Atlassian Site Name

Optional Atlassian site name or URL to connect to. By default, connects to the first accessible site. Set this when the authenticated account has access to multiple Jira sites.

your-company.atlassian.net
Authorize URL

The OAuth 2.0 Authorization URL for Atlassian. The audience parameter is required for cloud APIs.

https://auth.atlassian.com/authorize?audience=api.atlassian.com&prompt=consent
Client ID

OAuth 2.0 Client ID from the Atlassian Developer Console.

c9e4APadFFkbtTycoNtrHKBtYgUyZWy
Client Secret

OAuth 2.0 Client Secret from the Atlassian Developer Console.

ntDBx4ao5czkFu7Mzp5FTlYG0y3_ukxkSiPhwnTkhsdKHJITGRCGP3ZWlXTYyu
Scopes

Space-delimited list of OAuth 2.0 scopes for Jira Service Management access.

read:servicedesk-request write:servicedesk-request manage:servicedesk-customer read:jira-user read:ops-alert:jira-service-management write:ops-alert:jira-service-management delete:ops-alert:jira-service-management read:ops-config:jira-service-management write:ops-config:jira-service-management delete:ops-config:jira-service-management read:cmdb-object:jira write:cmdb-object:jira delete:cmdb-object:jira read:cmdb-schema:jira write:cmdb-schema:jira delete:cmdb-schema:jira read:cmdb-type:jira write:cmdb-type:jira delete:cmdb-type:jira read:cmdb-attribute:jira offline_access
Token URL

The OAuth 2.0 Token URL for Atlassian.

https://auth.atlassian.com/oauth/token

Ops Integration API Key

key: jsmOpsGenieKey

To authenticate with the Jira Service Management Ops Integration Events API, an integration GenieKey API key is required. This connection is only used by the Ops Integration Events actions (Create, Acknowledge, Close, Add Note, Get Request) — Ops Management and Assets actions use the OAuth 2.0 connection instead.

Prerequisites

  • A Jira Cloud instance with Jira Service Management Operations enabled
  • A JSM project where Operations is configured
  • Permission to manage integrations within that project

Setup Steps

  1. Open the Jira Service Management project where alerts will be ingested
  2. In the left sidebar, navigate to Operations and then Integrations
  3. Click Add integration and choose API
  4. Enter a name for the integration (e.g., My Integration) and choose the team that should own the resulting alerts
  5. Click Continue and then Turn on integration
  6. Copy the generated API key (also referred to as the GenieKey) — this value is only shown once

Refer to the JSM Ops REST API documentation for additional details about the integration endpoints and request shapes.

Configure the Connection

Create a connection of type Ops Integration API Key and configure the following field:

  • For API Key, paste the GenieKey value copied from the integration setup screen

The connection sends requests to https://api.atlassian.com/jsm/ops/integration/v2 with the header Authorization: GenieKey <api-key>. No additional configuration is required.

InputNotesExample
API Key

GenieKey API key generated from a JSM Ops API integration. Find this under Operations > Integrations in your JSM project.

eb243592-faa2-4ba2-a551-1afdf565c889

Triggers

New Ops Alerts

Fetches new alerts created in Jira Service Management Ops on a recurring schedule. | key: onNewOpsAlert

InputNotesExample
Connection

The Jira Service Management connection to use.

Additional Query

Atlassian Ops query terms appended to the built-in createdAt filter. Uses OpsGenie query language syntax.

status: open AND priority: P1

The New Ops Alerts trigger polls the Jira Service Management Ops (Operations) API on a recurring schedule and fires the flow with any alerts created since the previous poll. State is tracked between executions so each alert is only emitted once.

How It Works

On each scheduled run, the trigger:

  1. Reads the last polled timestamp from polling state (defaults to the current time on the first run)
  2. Builds an OpsGenie query language filter of the form createdAt > <epochMs>, optionally combined with the Additional Query input
  3. Fetches matching alerts from the List alerts endpoint
  4. Updates polling state to the current timestamp
  5. If no new alerts are found, the flow is not executed (the trigger reports polledNoChanges: true)

Filtering happens server-side via the OpsGenie query language. The createdAt filter uses epoch milliseconds and must not be converted to an ISO string — the API rejects that format.

Configuration

InputRequiredDescription
ConnectionYesAn OAuth 2.0 connection to Jira Service Management with Ops Management scopes
Additional QueryNoAtlassian Ops query terms appended to the built-in createdAt filter. Uses OpsGenie query language syntax (e.g., status: open AND priority: P1).

Refer to the OpsGenie query language documentation for filter syntax.

Returned Data

The trigger payload contains an array of new Ops alerts in body.data. Each entry is an alert summary from the JSM Ops API.

Example Payload
{
"body": {
"data": [
{
"id": "70413b54-5cfd-4f2e-bb2d-2e0a2f1c9b14",
"tinyId": "1791",
"alias": "event_573",
"message": "Disk usage above 90% on host-12",
"status": "open",
"createdAt": 1730462523000
}
]
}
}
Example Payload for New Ops Alerts
Loading…

New Service Requests

Fetches new service requests created in Jira Service Management on a recurring schedule. | key: onNewRequest

InputNotesExample
Connection

The Jira Service Management connection to use.

Service Desk ID

Limits new requests to a specific service desk. When omitted, requests from all accessible service desks are returned.

1

The New Service Requests trigger polls the Jira Service Management API on a recurring schedule and fires the flow with any service requests created since the previous poll. State is tracked between executions so each request is only emitted once.

How It Works

On each scheduled run, the trigger:

  1. Reads the last polled timestamp from polling state (defaults to the current time on the first run)
  2. Fetches service requests from the Get customer requests endpoint, optionally scoped to a specific service desk
  3. Filters results to requests with createdDate.epochMillis greater than the last polled timestamp
  4. Updates polling state to the current timestamp
  5. If no new requests are found, the flow is not executed (the trigger reports polledNoChanges: true)

Because the /request endpoint does not support server-side date filtering, the trigger fetches all accessible requests and filters them client-side. On high-volume service desks, scope the trigger to a single Service Desk ID to limit the result set.

Configuration

InputRequiredDescription
ConnectionYesAn OAuth 2.0 or Basic Authentication connection to Jira Service Management
Service Desk IDNoLimits new requests to a specific service desk. When omitted, requests from all accessible service desks are returned.

Returned Data

The trigger payload contains an array of new service requests in body.data. Each entry is a customer request object.

Example Payload
{
"body": {
"data": [
{
"issueId": "107001",
"issueKey": "HELPDESK-1",
"summary": "Request JSD help via REST",
"requestTypeId": "25",
"serviceDeskId": "10",
"createdDate": {
"epochMillis": 1444290120000,
"friendly": "Monday 14:42 PM",
"iso8601": "2015-10-08T14:42:00+0700",
"jira": "2015-10-08T14:42:00.000+0700"
},
"currentStatus": {
"status": "Waiting for Support",
"statusCategory": "NEW"
}
}
]
}
}
Example Payload for New Service Requests
Loading…

Data Sources

Select Approval

Fetches approvals for a service request and returns them as a dropdown. | key: selectApproval | type: picklist

InputNotesExample
Connection

The Jira Service Management connection to use.

Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Example Payload for Select Approval
Loading…

Select Asset Object Type

Fetches all object types in the chosen Assets/CMDB schema and returns them as a dropdown. | key: selectAssetObjectType | type: picklist

InputNotesExample
Schema ID

ID of the Assets object schema whose object types should be listed.

1
Connection

The Jira Service Management connection to use.

Example Payload for Select Asset Object Type
Loading…

Select Asset Schema

Fetches all Assets/CMDB object schemas and returns them as a dropdown. | key: selectAssetSchema | type: picklist

InputNotesExample
Connection

The Jira Service Management connection to use.

Example Payload for Select Asset Schema
Loading…

Select Ops Schedule

Fetches all JSM Ops on-call schedules and returns them as a dropdown. | key: selectOpsSchedule | type: picklist

InputNotesExample
Connection

The Jira Service Management connection to use.

Example Payload for Select Ops Schedule
Loading…

Select Organization

Fetches organizations and returns them as a dropdown. | key: selectOrganization | type: picklist

InputNotesExample
Connection

The Jira Service Management connection to use.

Example Payload for Select Organization
Loading…

Select Queue

Fetches queues for a service desk and returns them as a dropdown. | key: selectQueue | type: picklist

InputNotesExample
Connection

The Jira Service Management connection to use.

Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Select Queue
Loading…

Select Request

Fetches service requests for a service desk and returns them as a dropdown. | key: selectRequest | type: picklist

InputNotesExample
Connection

The Jira Service Management connection to use.

Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Select Request
Loading…

Select Request Type

Fetches request types for a service desk and returns them as a dropdown. | key: selectRequestType | type: picklist

InputNotesExample
Connection

The Jira Service Management connection to use.

Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Select Request Type
Loading…

Select Service Desk

Fetches all service desks and returns them as a dropdown. | key: selectServiceDesk | type: picklist

InputNotesExample
Connection

The Jira Service Management connection to use.

Example Payload for Select Service Desk
Loading…

Select Transition

Fetches available status transitions for a service request and returns them as a dropdown. | key: selectTransition | type: picklist

InputNotesExample
Connection

The Jira Service Management connection to use.

Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Example Payload for Select Transition
Loading…

Actions

Acknowledge Integration Alert

Acknowledges an alert via the integration API. Returns an asynchronous request ID. | key: acknowledgeIntegrationAlert

InputNotesExample
Alert Identifier

The alert identifier — by default the alert ID. To use the tiny ID or alias, set Identifier Type accordingly.

70413a06-38d6-4c85-92b8-5ebc900d42e2
Identifier Type

Format of the alert identifier. Use alias only when the alert is in OPEN status — closed alerts cannot be referenced by alias.

id
Note

Additional note posted alongside the alert action.

Acknowledged from monitoring runbook
Source

Source of the alert. Defaults to the IP address of the request when omitted.

Datadog
User

Display name of the user performing the action. Used to attribute the alert action in audit history.

Monica Geller
Connection

The Jira Service Management connection to use.

Example Payload for Acknowledge Integration Alert
Loading…

Acknowledge Ops Alert

Acknowledges an Ops alert. | key: acknowledgeOpsAlert

InputNotesExample
Connection

The Jira Service Management connection to use.

Alert Identifier

The identifier of the alert.

70413a06-38d6-4c85-92b8-5ebc900d42e2
Example Payload for Acknowledge Ops Alert
Loading…

Add Attachment

Attaches a previously uploaded temporary file to a service request. | key: addAttachment

InputNotesExample
Temporary File ID

The ID of the temporary file previously uploaded via the Upload Attachment action.

temp:123456
Connection

The Jira Service Management connection to use.

Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Example Payload for Add Attachment
Loading…

Add Comment

Adds a comment to a service request. | key: addComment

InputNotesExample
Comment Body

The message to post on the request. Supports plain text and is rendered in the customer portal.

We are investigating the issue and will update you shortly.
Connection

The Jira Service Management connection to use.

Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Public

When true, the comment is visible to the customer. When false, the comment is internal only.

true
Example Payload for Add Comment
Loading…

Add Customers to Service Desk

Adds one or more existing customers to the specified service desk by accountId. | key: addCustomers

InputNotesExample
Account IDs

The Atlassian accountIds to include in the request. Provide a JSON array of string identifiers.

[
  "5b10ac8d82e05b22cc7d4ef5",
  "5b10a2844c20165700ede21g"
]
Connection

The Jira Service Management connection to use.

Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Add Customers to Service Desk
Loading…

Add Integration Alert Note

Adds a note to an alert via the integration API. Returns an asynchronous request ID. | key: addIntegrationAlertNote

InputNotesExample
Alert Identifier

The alert identifier — by default the alert ID. To use the tiny ID or alias, set Identifier Type accordingly.

70413a06-38d6-4c85-92b8-5ebc900d42e2
Identifier Type

Format of the alert identifier. Use alias only when the alert is in OPEN status — closed alerts cannot be referenced by alias.

id
Note

The note content to add to the alert.

Investigating now — engaging the on-call engineer.
Source

Source of the alert. Defaults to the IP address of the request when omitted.

Datadog
User

Display name of the user performing the action. Used to attribute the alert action in audit history.

Monica Geller
Connection

The Jira Service Management connection to use.

Example Payload for Add Integration Alert Note
Loading…

Add Organization to Service Desk

Links an organization to the specified service desk. | key: addServiceDeskOrganization

InputNotesExample
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Add Organization to Service Desk
Loading…

Add Users to Organization

Adds users to an organization by accountId. | key: addOrganizationUsers

InputNotesExample
Account IDs

The Atlassian accountIds to include in the request. Provide a JSON array of string identifiers.

[
  "5b10ac8d82e05b22cc7d4ef5",
  "5b10a2844c20165700ede21g"
]
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Example Payload for Add Users to Organization
Loading…

Approve or Decline Request

Approves or declines a pending approval on a service request. | key: approveRequest

InputNotesExample
Decision

Whether to approve or decline the request.

Approval ID

The ID of the approval to respond to. Use the List Approvals action or the Approval data source to find this value.

1
Connection

The Jira Service Management connection to use.

Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Example Payload for Approve or Decline Request
Loading…

Close Integration Alert

Closes (resolves) an alert via the integration API. Returns an asynchronous request ID. | key: closeIntegrationAlert

InputNotesExample
Alert Identifier

The alert identifier — by default the alert ID. To use the tiny ID or alias, set Identifier Type accordingly.

70413a06-38d6-4c85-92b8-5ebc900d42e2
Identifier Type

Format of the alert identifier. Use alias only when the alert is in OPEN status — closed alerts cannot be referenced by alias.

id
Note

Additional note posted alongside the alert action.

Acknowledged from monitoring runbook
Source

Source of the alert. Defaults to the IP address of the request when omitted.

Datadog
User

Display name of the user performing the action. Used to attribute the alert action in audit history.

Monica Geller
Connection

The Jira Service Management connection to use.

Example Payload for Close Integration Alert
Loading…

Close Ops Alert

Closes (resolves) an Ops alert. | key: closeOpsAlert

InputNotesExample
Connection

The Jira Service Management connection to use.

Alert Identifier

The identifier of the alert.

70413a06-38d6-4c85-92b8-5ebc900d42e2
Example Payload for Close Ops Alert
Loading…

Create Asset Object

Creates a new Assets/CMDB object of the specified object type with the provided attributes. | key: createAssetObject

InputNotesExample
Additional Fields

Extra request body properties to merge into the payload alongside the standard inputs. Provide a JSON object keyed by field name.

{
  "email": "sally@netflix.com"
}
Attributes

JSON array of attribute payloads for this object. Each item has the shape { objectTypeAttributeId, objectAttributeValues: [{ value }] }.

[
  {
    "objectTypeAttributeId": 135,
    "objectAttributeValues": [
      {
        "value": "web-prod-01"
      }
    ]
  }
]
Object Type ID

ID of the object type. Use the Select Object Type data source after picking a schema.

23
Schema ID

ID of the Assets object schema. Use the Select Schema data source or List Schemas action.

1
Connection

The Jira Service Management connection to use.

Example Payload for Create Asset Object
Loading…

Create Customer

Creates a portal-only customer account, adds them to the specified service desk, and sends an invite email. | key: createCustomer

InputNotesExample
Connection

The Jira Service Management connection to use.

Email

The email address of the new portal-only customer.

jane.smith@example.com
Display Name

The full name shown for the customer in the portal and on issues they raise.

Jane Smith
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Create Customer
Loading…

Create Integration Alert

Ingests a new alert into JSM Ops via the integration API. Returns an asynchronous request ID; use Get Integration Alert Request to check processing status. | key: createIntegrationAlert

InputNotesExample
Actions

JSON array of custom action names that can later be invoked on the alert.

[
  "restart",
  "ping"
]
Alias

Client-defined identifier for deduplication. Subsequent alerts with the same alias and OPEN status are de-duplicated to the first one.

disk-usage-web-prod-01
Description

Detailed message body. Markdown is supported. Truncated to 15,000 characters by Atlassian.

Disk /var has crossed the 95% threshold and continues to grow.
Details

JSON object of arbitrary key/value pairs stored alongside the alert.

{
  "region": "us-east-1",
  "host": "web-prod-01"
}
Entity

Optional entity field used to specify which domain the alert is related to (e.g. a server name).

web-prod-01
Message

The alert message that summarises what happened. Truncated to 130 characters by Atlassian.

Disk usage at 95% on web-prod-01
Note

Additional note posted alongside the alert action.

Acknowledged from monitoring runbook
Priority

Priority level of the alert. Defaults to P3.

P3
Responders

JSON array of responder objects to assign. Each item must include type (team, user, escalation, schedule) and one of id, name, or username.

[
  {
    "type": "team",
    "name": "Platform"
  },
  {
    "type": "user",
    "username": "oncall@example.com"
  }
]
Source

Source of the alert. Defaults to the IP address of the request when omitted.

Datadog
Tags

JSON array of string tags to attach to the alert.

[
  "production",
  "disk"
]
User

Display name of the user performing the action. Used to attribute the alert action in audit history.

Monica Geller
Visible To

JSON array restricting alert visibility to specific teams or users. Same shape as Responders.

[
  {
    "type": "team",
    "name": "Platform"
  }
]
Connection

The Jira Service Management connection to use.

Example Payload for Create Integration Alert
Loading…

Create Ops Alert

Creates a new alert in JSM Ops. Returns an asynchronous request ID; use Get Ops Alert to fetch the resulting alert once processed. | key: createOpsAlert

InputNotesExample
Additional Fields

Extra request body properties to merge into the payload alongside the standard inputs. Provide a JSON object keyed by field name.

{
  "email": "sally@netflix.com"
}
Connection

The Jira Service Management connection to use.

Alias

Client-defined identifier for deduplication. Subsequent alerts with the same alias and OPEN status are de-duplicated to the first one.

disk-usage-web-prod-01
Description

Detailed message body. Markdown is supported. Truncated to 15,000 characters by Atlassian.

Disk /var has crossed the 95% threshold and continues to grow.
Message

Brief alert summary. Truncated to 130 characters by Atlassian.

Disk usage at 95% on web-prod-01
Priority

Priority level of the alert. Defaults to P3.

P3
Tags

JSON array of string tags to attach to the alert.

[
  "production",
  "disk"
]
Example Payload for Create Ops Alert
Loading…

Create Organization

Creates a new organization. | key: createOrganization

InputNotesExample
Connection

The Jira Service Management connection to use.

Organization Name

A unique display label for the organization, shown to agents and customers in the portal.

Acme Corp IT
Example Payload for Create Organization
Loading…

Create Portal-Only Customer

Creates a portal-only customer account without linking them to a service desk. | key: createPortalOnlyCustomer

InputNotesExample
Connection

The Jira Service Management connection to use.

Email

The email address of the new portal-only customer.

jane.smith@example.com
Display Name

The full name shown for the customer in the portal and on issues they raise.

Jane Smith
Example Payload for Create Portal-Only Customer
Loading…

Create Request

Creates a new service request in the specified service desk. | key: createRequest

InputNotesExample
Additional Fields

Extra request body properties to merge into the payload alongside the standard inputs. Provide a JSON object keyed by field name.

{
  "email": "sally@netflix.com"
}
Connection

The Jira Service Management connection to use.

Raise On Behalf Of

The accountId of the customer to raise the request on behalf of. If omitted, the request is raised by the authenticated user.

5b10ac8d82e05b22cc7d4ef5
Description

Additional detail about the request. Displayed on the request view for agents and customers.

My laptop stopped responding after the latest update.
Field Values

JSON object of additional request field values required by the request type. Keys are field IDs.

{"priority": {"name": "High"}, "customfield_10010": "value"}
Summary

A brief, one-line subject shown in the portal and issue list.

Laptop won't start
Request Type ID

The ID of the request type to create the request as. Use the List Request Types action or the Request Type data source.

5
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Create Request
Loading…

Delete Asset Object

Deletes an Assets/CMDB object by ID. | key: deleteAssetObject

InputNotesExample
Object ID

Numeric ID of the Assets object (e.g. 425). Distinct from the human-readable object key (e.g. ITAM-425).

425
Connection

The Jira Service Management connection to use.

Example Payload for Delete Asset Object
Loading…

Delete Ops Alert

Deletes an Ops alert. | key: deleteOpsAlert

InputNotesExample
Connection

The Jira Service Management connection to use.

Alert Identifier

The identifier of the alert.

70413a06-38d6-4c85-92b8-5ebc900d42e2
Example Payload for Delete Ops Alert
Loading…

Delete Organization

Deletes an organization by ID. | key: deleteOrganization

InputNotesExample
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Example Payload for Delete Organization
Loading…

Delete Organization Property

Removes a custom property from an organization by key. | key: deleteOrganizationProperty

InputNotesExample
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Property Key

The key identifying the custom property to store against the organization.

tier
Example Payload for Delete Organization Property
Loading…

Get Asset Object

Returns a single Assets/CMDB object by ID. | key: getAssetObject

InputNotesExample
Object ID

Numeric ID of the Assets object (e.g. 425). Distinct from the human-readable object key (e.g. ITAM-425).

425
Connection

The Jira Service Management connection to use.

Example Payload for Get Asset Object
Loading…

Get Asset Schema

Returns a single Assets/CMDB object schema by ID. | key: getAssetSchema

InputNotesExample
Schema ID

ID of the Assets object schema. Use the Select Schema data source or List Schemas action.

1
Connection

The Jira Service Management connection to use.

Example Payload for Get Asset Schema
Loading…

Get Integration Alert Request

Returns the processing status of an asynchronous Integration Events request by ID. | key: getIntegrationAlertRequest

InputNotesExample
Connection

The Jira Service Management connection to use.

Request ID

The async request ID returned by a previous Ops Integration Events action.

8eb01b62-04a5-4d57-a4a8-602e6ef5deaf
Example Payload for Get Integration Alert Request
Loading…

Get Ops Alert

Returns a single Ops alert by identifier. | key: getOpsAlert

InputNotesExample
Connection

The Jira Service Management connection to use.

Alert Identifier

The identifier of the alert.

70413a06-38d6-4c85-92b8-5ebc900d42e2
Example Payload for Get Ops Alert
Loading…

Get Ops On-Call

Returns the recipients currently on-call for the specified Ops schedule. | key: getOpsOnCall

InputNotesExample
Connection

The Jira Service Management connection to use.

Reference Date

ISO-8601 timestamp at which to evaluate the on-call list. Defaults to the current time.

2026-05-04T18:30:00Z
Flatten On-Call

When true, returns only the user IDs of the on-call participants. When false, returns the full rotation tree.

false
Schedule

The ID of the schedule.

55a1ec02-92b6-4c95-9f0a-44213c8c5fb6
Example Payload for Get Ops On-Call
Loading…

Get Ops Schedule

Returns a single Ops schedule by ID. | key: getOpsSchedule

InputNotesExample
Connection

The Jira Service Management connection to use.

Schedule

The ID of the schedule.

55a1ec02-92b6-4c95-9f0a-44213c8c5fb6
Example Payload for Get Ops Schedule
Loading…

Get Organization

Returns a single organization by ID. | key: getOrganization

InputNotesExample
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Example Payload for Get Organization
Loading…

Get Organization Property

Returns the value of a single organization property. | key: getOrganizationProperty

InputNotesExample
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Property Key

The key identifying the custom property to store against the organization.

tier
Example Payload for Get Organization Property
Loading…

Get Request

Returns a single service request by issue ID or key. | key: getRequest

InputNotesExample
Connection

The Jira Service Management connection to use.

Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Example Payload for Get Request
Loading…

Get Request Type

Returns a single request type for a service desk. | key: getRequestType

InputNotesExample
Connection

The Jira Service Management connection to use.

Request Type ID

The ID of the request type to create the request as. Use the List Request Types action or the Request Type data source.

5
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Get Request Type
Loading…

Get Service Desk

Returns a single service desk by ID. | key: getServiceDesk

InputNotesExample
Connection

The Jira Service Management connection to use.

Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Get Service Desk
Loading…

List Approvals

Returns the approvals for a service request. | key: listApprovals

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Limit

The maximum number of items to return per page.

50
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Approvals
Loading…

List Asset Schemas

Returns all Assets/CMDB object schemas in the workspace. | key: listAssetSchemas

InputNotesExample
Additional Query Parameters

Extra query string parameters to merge into the request URL alongside the standard inputs. Provide a JSON object keyed by parameter name.

{
  "includeCounts": true
}
Max Results

Maximum number of results per page.

50
Start At

Index of the first result to return.

0
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Example Payload for List Asset Schemas
Loading…

List Comments

Returns comments for a service request. | key: listComments

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Limit

The maximum number of items to return per page.

50
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Comments
Loading…

List Customers

Returns customers associated with a service desk. | key: listCustomers

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Limit

The maximum number of items to return per page.

50
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Customers
Loading…

List Ops Alerts

Returns alerts in JSM Ops, optionally filtered by query. | key: listOpsAlerts

InputNotesExample
Additional Query Parameters

Extra query string parameters to merge into the request URL alongside the standard inputs. Provide a JSON object keyed by parameter name.

{
  "includeCounts": true
}
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Offset

Index of the first result to return.

0
Order

Sort order applied alongside the Sort field.

desc
Query

Atlassian Ops query string used to filter the alert list (e.g. status: open AND priority: P1).

status: open
Size

Maximum number of results per page (Atlassian max: 100).

20
Sort

Field to sort the alerts by (e.g. createdAt, priority).

createdAt
Example Payload for List Ops Alerts
Loading…

List Ops Schedules

Returns all on-call schedules configured in JSM Ops. | key: listOpsSchedules

InputNotesExample
Additional Query Parameters

Extra query string parameters to merge into the request URL alongside the standard inputs. Provide a JSON object keyed by parameter name.

{
  "includeCounts": true
}
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Offset

Index of the first result to return.

0
Query

Filters schedules by name (substring match).

production
Size

Maximum number of results per page (Atlassian max: 50).

25
Example Payload for List Ops Schedules
Loading…

List Organization Properties

Returns the property keys stored against an organization. | key: listOrganizationProperties

InputNotesExample
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Example Payload for List Organization Properties
Loading…

List Organization Users

Returns users associated with an organization. | key: listOrganizationUsers

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Limit

The maximum number of items to return per page.

50
Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Organization Users
Loading…

List Organizations

Returns all organizations in the Jira Service Management instance. | key: listOrganizations

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Limit

The maximum number of items to return per page.

50
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Organizations
Loading…

List Queue Issues

Returns the issues in a service desk queue. | key: listQueueIssues

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Limit

The maximum number of items to return per page.

50
Queue ID

The unique identifier of the queue. Use the List Queues action or the Queue data source.

3
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Queue Issues
Loading…

List Queues

Returns queues for a service desk. | key: listQueues

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Limit

The maximum number of items to return per page.

50
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Queues
Loading…

List Request Types

Returns all request types for a service desk. | key: listRequestTypes

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Limit

The maximum number of items to return per page.

50
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Request Types
Loading…

List Requests

Returns service requests for the given service desk. | key: listRequests

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Limit

The maximum number of items to return per page.

50
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Requests
Loading…

List Schema Object Types

Returns all object types defined in the specified Assets/CMDB object schema. | key: listSchemaObjectTypes

InputNotesExample
Additional Query Parameters

Extra query string parameters to merge into the request URL alongside the standard inputs. Provide a JSON object keyed by parameter name.

{
  "includeCounts": true
}
Schema ID

ID of the Assets object schema. Use the Select Schema data source or List Schemas action.

1
Connection

The Jira Service Management connection to use.

Example Payload for List Schema Object Types
Loading…

List Service Desk Organizations

Returns organizations linked to a service desk. | key: listServiceDeskOrganizations

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Limit

The maximum number of items to return per page.

50
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Service Desk Organizations
Loading…

List Service Desks

Returns all service desks in the Jira Service Management instance. | key: listServiceDesks

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Limit

The maximum number of items to return per page.

50
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Service Desks
Loading…

List SLA Information

Returns SLA information for a service request. | key: listSla

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Limit

The maximum number of items to return per page.

50
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List SLA Information
Loading…

List Transitions

Returns available status transitions for a service request. | key: listTransitions

InputNotesExample
Connection

The Jira Service Management connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Ignores start and limit when true.

false
Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Limit

The maximum number of items to return per page.

50
Start

The starting index of the returned items. First item is 0.

50
Example Payload for List Transitions
Loading…

Raw Request

Send raw HTTP request to the Jira Service Management REST API. | key: rawRequest

InputNotesExample
Connection

The Jira Service Management connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (e.g., /servicedesk). The base URL is resolved from the connection automatically.

/servicedesk
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Remove Customers from Service Desk

Removes one or more customers from the specified service desk by accountId. | key: removeCustomers

InputNotesExample
Account IDs

The Atlassian accountIds to include in the request. Provide a JSON array of string identifiers.

[
  "5b10ac8d82e05b22cc7d4ef5",
  "5b10a2844c20165700ede21g"
]
Connection

The Jira Service Management connection to use.

Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Remove Customers from Service Desk
Loading…

Remove Organization from Service Desk

Unlinks an organization from the specified service desk. | key: removeServiceDeskOrganization

InputNotesExample
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Remove Organization from Service Desk
Loading…

Remove Users from Organization

Removes users from an organization by accountId. | key: removeOrganizationUsers

InputNotesExample
Account IDs

The Atlassian accountIds to include in the request. Provide a JSON array of string identifiers.

[
  "5b10ac8d82e05b22cc7d4ef5",
  "5b10a2844c20165700ede21g"
]
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Example Payload for Remove Users from Organization
Loading…

Revoke Portal-Only Access

Revokes a user's portal-only access so they can no longer log in as a portal customer. | key: revokePortalAccess

InputNotesExample
Account ID

The Atlassian accountId of the customer.

5b10ac8d82e05b22cc7d4ef5
Connection

The Jira Service Management connection to use.

Example Payload for Revoke Portal-Only Access
Loading…

Search Asset Objects

Searches Assets/CMDB objects using AQL (Asset Query Language). | key: searchAssetObjects

InputNotesExample
Include Attributes

When true, full attribute values are returned for each object. Disable to reduce payload size.

true
Max Results

Maximum number of results per page.

50
AQL Query

Asset Query Language expression used to filter objects (e.g. objectType = "Computer" AND Name LIKE "web-*").

objectType = "Computer"
Start At

Index of the first result to return.

0
Connection

The Jira Service Management connection to use.

Example Payload for Search Asset Objects
Loading…

Set Organization Property

Stores a custom JSON value against an organization under the specified property key. | key: setOrganizationProperty

InputNotesExample
Connection

The Jira Service Management connection to use.

Organization ID

The unique identifier of the organization. Use the List Organizations action or the Organization data source.

2
Property Key

The key identifying the custom property to store against the organization.

tier
Property Value

JSON value to store for the property. Can be any valid JSON (object, array, string, number, or boolean).

{
  "level": "enterprise",
  "region": "us-east"
}
Example Payload for Set Organization Property
Loading…

Snooze Ops Alert

Snoozes an Ops alert until the supplied ISO-8601 timestamp. | key: snoozeOpsAlert

InputNotesExample
Connection

The Jira Service Management connection to use.

Alert Identifier

The identifier of the alert.

70413a06-38d6-4c85-92b8-5ebc900d42e2
Snooze Until

ISO-8601 timestamp until which the alert is snoozed (e.g. 2026-05-04T18:30:00Z).

2026-05-04T18:30:00Z
Example Payload for Snooze Ops Alert
Loading…

Transition Request

Transitions a service request to a new status. | key: transitionRequest

InputNotesExample
Comment

A message posted on the request when the transition is executed. Visible to the customer by default.

Connection

The Jira Service Management connection to use.

Issue ID or Key

The ID or key of the service request issue (e.g., IT-42 or 10001). Use the Select Request data source or List Requests action to find this value.

IT-42
Transition ID

The ID of the transition to apply. Use the List Transitions action or the Transition data source to find available transitions.

5
Example Payload for Transition Request
Loading…

Update Asset Object

Updates an existing Assets/CMDB object with the supplied attributes. | key: updateAssetObject

InputNotesExample
Additional Fields

Extra request body properties to merge into the payload alongside the standard inputs. Provide a JSON object keyed by field name.

{
  "email": "sally@netflix.com"
}
Attributes

JSON array of attribute payloads for this object. Each item has the shape { objectTypeAttributeId, objectAttributeValues: [{ value }] }.

[
  {
    "objectTypeAttributeId": 135,
    "objectAttributeValues": [
      {
        "value": "web-prod-01"
      }
    ]
  }
]
Object ID

Numeric ID of the Assets object (e.g. 425). Distinct from the human-readable object key (e.g. ITAM-425).

425
Object Type ID

ID of the object type. Use the Select Object Type data source after picking a schema.

23
Connection

The Jira Service Management connection to use.

Example Payload for Update Asset Object
Loading…

Upload Temporary File

Uploads a file as a temporary attachment for later use with Add Attachment. | key: uploadTemporaryFile

InputNotesExample
Connection

The Jira Service Management connection to use.

File Contents

The contents of the file to upload. Can be a string or binary data (e.g., image or PDF) from a previous step.

My File Contents
File Name

The filename to associate with the uploaded attachment, including the extension (e.g., report.pdf).

atlassian.png
Service Desk ID

The unique identifier of the service desk. Use the List Service Desks action or the Service Desk data source to find this value.

1
Example Payload for Upload Temporary File
Loading…

Changelog

2026-05-13

Added JSM Operations and Assets / CMDB support:

  • Added Integration Events actions — Create Integration Alert, Acknowledge Integration Alert, Close Integration Alert, Add Integration Alert Note, and Get Integration Alert Request — backed by a new GenieKey API key connection for the Atlassian Ops integration ingestion API.
  • Added Ops Alerts actions — List Ops Alerts, Get Ops Alert, Create Ops Alert, Delete Ops Alert, Acknowledge Ops Alert, Close Ops Alert, and Snooze Ops Alert — for the JSM Operations REST API.
  • Added Ops Schedules actions — List Ops Schedules, Get Ops Schedule, and Get Ops On-Call — plus a Select Ops Schedule data source.
  • Added Assets / CMDB Objects actions — Search Asset Objects, Get Asset Object, Create Asset Object, Update Asset Object, and Delete Asset Object — and Schemas actions — List Asset Schemas, Get Asset Schema, and List Schema Object Types — plus Select Asset Schema and Select Asset Object Type data sources.
  • Expanded the OAuth 2.0 connection's default scopes to cover Ops Management (read/write/delete:ops-alert, read/write/delete:ops-config) and Assets/CMDB (read/write/delete:cmdb-object, cmdb-schema, cmdb-type, and read:cmdb-attribute).
  • Added shared cloudId resolution and pagination helpers for the JSM Ops (offset/size with links.next) and Assets (startAt/maxResults/isLast) response envelopes.
  • On New Request Trigger — triggers on new service requests in a service desk
  • On New Ops Alert Trigger — triggers on new alerts in JSM Operations

2026-04-30

Initial release of Jira Service Management component with support for OAuth 2.0 and Basic Authentication, service request management, organizations, customers, request types, queues, webhook triggers, service desk ↔ customer and organization associations, organization properties, portal-only customer management, and dynamic data source dropdowns