Use Jira Service Management in Sim to manage service requests, customers, organizations, SLAs, and queues. The actions below document the supported service-desk operations and their required fields.
Sim requests these scopes when someone connects a Jira account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.
Setting Value Redirect URI <NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/jiraEnvironment variables JIRA_CLIENT_ID, JIRA_CLIENT_SECRET
Scope Description read:jira-userView Jira user profiles, including email addresses read:jira-workView Jira projects and issues, and search issues write:jira-workCreate, edit, and delete Jira issues, comments, and worklogs read:meRead profile information offline_accessAccess account when not using the application read:issue.vote:jiraRead Jira issue votes read:user:jiraView Jira users delete:issue:jiraDelete Jira issues delete:comment:jiraDelete comments from Jira issues delete:attachment:jiraDelete attachments from Jira issues delete:issue-worklog:jiraDelete worklog entries from Jira issues delete:issue-link:jiraDelete links between Jira issues read:servicedesk-requestView service desk requests write:servicedesk-requestCreate and update service desk requests manage:servicedesk-customerManage service desk customers and organizations read:servicedesk:jira-service-managementView service desks and their settings read:requesttype:jira-service-managementView request types available in service desks read:request:jira-service-managementView customer requests in service desks write:request:jira-service-managementCreate customer requests in service desks read:request.comment:jira-service-managementView comments on customer requests write:request.comment:jira-service-managementAdd comments to customer requests read:servicedesk.customer:jira-service-managementView customers linked to service desks write:servicedesk.customer:jira-service-managementAdd and remove customers from service desks read:organization:jira-service-managementView organizations write:organization:jira-service-managementCreate and manage organizations read:servicedesk.organization:jira-service-managementView organizations linked to service desks write:servicedesk.organization:jira-service-managementAdd and remove organizations from service desks read:queue:jira-service-managementView service desk queues and their issues read:request.sla:jira-service-managementView SLA information for customer requests read:request.status:jira-service-managementView status of customer requests write:request.status:jira-service-managementTransition customer request status read:request.participant:jira-service-managementView participants on customer requests write:request.participant:jira-service-managementAdd and remove participants from customer requests read:request.approval:jira-service-managementView approvals on customer requests write:request.approval:jira-service-managementApprove or decline customer requests read:cmdb-object:jiraView Assets objects and run AQL searches write:cmdb-object:jiraCreate and update Assets objects delete:cmdb-object:jiraDelete Assets objects read:cmdb-schema:jiraView Assets object schemas read:cmdb-type:jiraView Assets object types read:cmdb-attribute:jiraView Assets object type attributes
Integrate with Jira Service Management for IT service management. Create and manage service requests, handle customers and organizations, track SLAs, and manage queues.
Get all service desks from Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) expandstring No Comma-separated fields to expand in the response startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation serviceDesksarray List of service desks ↳ id string Service desk ID ↳ projectId string Associated Jira project ID ↳ projectName string Associated project name ↳ projectKey string Associated project key ↳ name string Service desk name ↳ description string Service desk description ↳ leadDisplayName string Project lead display name totalnumber Total number of service desks isLastPageboolean Whether this is the last page
Get request types for a service desk in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) serviceDeskIdstring Yes Service Desk ID (e.g., "1", "2") searchQuerystring No Filter request types by name groupIdstring No Filter by request type group ID expandstring No Comma-separated fields to expand in the response startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation requestTypesarray List of request types ↳ id string Request type ID ↳ name string Request type name ↳ description string Request type description ↳ helpText string Help text for customers ↳ issueTypeId string Associated Jira issue type ID ↳ serviceDeskId string Parent service desk ID ↳ groupIds json Groups this request type belongs to ↳ icon json Request type icon with id and links ↳ restrictionStatus string OPEN or RESTRICTED totalnumber Total number of request types isLastPageboolean Whether this is the last page
Create a new service request in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) serviceDeskIdstring Yes Service Desk ID (e.g., "1", "2") requestTypeIdstring Yes Request Type ID (e.g., "10", "15") summarystring No Summary/title for the service request (required unless using Form Answers) descriptionstring No Description for the service request raiseOnBehalfOfstring No Account ID of customer to raise request on behalf of requestFieldValuesjson No Request field values as key-value pairs (overrides summary/description if provided) formAnswersjson No Form answers using numeric form question IDs as keys (e.g., {"1": {"text": "Title"}, "4": {"choices": ["5"]}}). Keys are question IDs from the Jira Form, not Jira field names. requestParticipantsstring No Comma-separated account IDs to add as request participants channelstring No Channel the request originates from (e.g., portal, email)
Parameter Type Description tsstring Timestamp of the operation issueIdstring Created request issue ID issueKeystring Created request issue key (e.g., SD-123) requestTypeIdstring Request type ID serviceDeskIdstring Service desk ID createdDatejson Creation date with iso8601, friendly, epochMillis currentStatusjson Current status with status name and category reporterjson Reporter user with accountId, displayName, emailAddress successboolean Whether the request was created successfully urlstring URL to the created request
Get a single service request from Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) expandstring No Comma-separated fields to expand: participant, status, sla, requestType, serviceDesk, attachment, comment, action
Parameter Type Description tsstring Timestamp of the operation issueIdstring Jira issue ID issueKeystring Issue key (e.g., SD-123) requestTypeIdstring Request type ID serviceDeskIdstring Service desk ID createdDatejson Creation date with iso8601, friendly, epochMillis currentStatusobject Current request status ↳ status string Status name ↳ statusCategory string Status category (NEW, INDETERMINATE, DONE) ↳ statusDate json Status change date with iso8601, friendly, epochMillis reporterobject Reporter user details ↳ accountId string Atlassian account ID ↳ displayName string User display name ↳ emailAddress string User email address ↳ active boolean Whether the account is active requestFieldValuesarray Request field values ↳ fieldId string Field identifier ↳ label string Human-readable field label ↳ value json Field value ↳ renderedValue json HTML-rendered field value urlstring URL to the request requestjson The service request object
Get multiple service requests from Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) serviceDeskIdstring No Filter by service desk ID (e.g., "1", "2") requestOwnershipstring No Filter by ownership: OWNED_REQUESTS, PARTICIPATED_REQUESTS, APPROVER, ALL_REQUESTS requestStatusstring No Filter by status: OPEN_REQUESTS, CLOSED_REQUESTS, ALL_REQUESTS requestTypeIdstring No Filter by request type ID searchTermstring No Search term to filter requests (e.g., "password reset", "laptop") expandstring No Comma-separated fields to expand: participant, status, sla, requestType, serviceDesk, attachment, comment, action startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation requestsarray List of service requests ↳ issueId string Jira issue ID ↳ issueKey string Issue key (e.g., SD-123) ↳ requestTypeId string Request type ID ↳ serviceDeskId string Service desk ID ↳ createdDate json Creation date with iso8601, friendly, epochMillis ↳ currentStatus object Current request status ↳ status string Status name ↳ statusCategory string Status category (NEW, INDETERMINATE, DONE) ↳ statusDate json Status change date with iso8601, friendly, epochMillis ↳ reporter object Reporter user details ↳ accountId string Atlassian account ID ↳ displayName string User display name ↳ emailAddress string User email address ↳ active boolean Whether the account is active ↳ requestFieldValues array Request field values ↳ fieldId string Field identifier ↳ label string Human-readable field label ↳ value json Field value ↳ renderedValue json HTML-rendered field value totalnumber Total number of requests in current page isLastPageboolean Whether this is the last page
Add a comment (public or internal) to a service request in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) bodystring Yes Comment body text isPublicboolean Yes Whether the comment is public (visible to customer) or internal (true/false)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key commentIdstring Created comment ID bodystring Comment body text isPublicboolean Whether the comment is public authorobject Comment author ↳ accountId string Atlassian account ID ↳ displayName string User display name ↳ emailAddress string User email address ↳ active boolean Whether the account is active createdDatejson Comment creation date with iso8601, friendly, epochMillis successboolean Whether the comment was added successfully
Get comments for a service request in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) isPublicboolean No Filter to only public comments (true/false) internalboolean No Filter to only internal comments (true/false) expandstring No Comma-separated fields to expand: renderedBody, attachment startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key commentsarray List of comments ↳ id string Comment ID ↳ body string Comment body text ↳ public boolean Whether the comment is public ↳ author object Comment author ↳ accountId string Atlassian account ID ↳ displayName string User display name ↳ emailAddress string User email address ↳ active boolean Whether the account is active ↳ created json Creation date with iso8601, friendly, epochMillis ↳ renderedBody json HTML-rendered comment body (when expand=renderedBody) totalnumber Total number of comments isLastPageboolean Whether this is the last page
Get customers for a service desk in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) serviceDeskIdstring Yes Service Desk ID (e.g., "1", "2") querystring No Search query to filter customers (e.g., "john", "acme") startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation customersarray List of customers ↳ accountId string Atlassian account ID ↳ displayName string Display name ↳ emailAddress string Email address ↳ active boolean Whether the account is active ↳ timeZone string User timezone totalnumber Total number of customers isLastPageboolean Whether this is the last page
Add customers to a service desk in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) serviceDeskIdstring Yes Service Desk ID (e.g., "1", "2") accountIdsstring Yes Comma-separated Atlassian account IDs to add as customers
Parameter Type Description tsstring Timestamp of the operation serviceDeskIdstring Service desk ID successboolean Whether customers were added successfully
Get organizations for a service desk in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) serviceDeskIdstring Yes Service Desk ID (e.g., "1", "2") startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation organizationsarray List of organizations ↳ id string Organization ID ↳ name string Organization name totalnumber Total number of organizations isLastPageboolean Whether this is the last page
Create a new organization in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) namestring Yes Name of the organization to create
Parameter Type Description tsstring Timestamp of the operation organizationIdstring ID of the created organization namestring Name of the created organization successboolean Whether the operation succeeded
Add an organization to a service desk in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) serviceDeskIdstring Yes Service Desk ID (e.g., "1", "2") organizationIdstring Yes Organization ID to add to the service desk
Parameter Type Description tsstring Timestamp of the operation serviceDeskIdstring Service Desk ID organizationIdstring Organization ID added successboolean Whether the operation succeeded
Get queues for a service desk in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) serviceDeskIdstring Yes Service Desk ID (e.g., "1", "2") includeCountboolean No Include issue count for each queue (true/false) startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation queuesarray List of queues ↳ id string Queue ID ↳ name string Queue name ↳ jql string JQL filter for the queue ↳ fields json Fields displayed in the queue ↳ issueCount number Number of issues in the queue totalnumber Total number of queues isLastPageboolean Whether this is the last page
Get SLA information for a service request in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key slasarray List of SLA metrics ↳ id string SLA metric ID ↳ name string SLA metric name ↳ completedCycles json Completed SLA cycles with startTime, stopTime, breachTime, breached, goalDuration, elapsedTime, remainingTime (each time as DateDTO, durations as DurationDTO) ↳ ongoingCycle json Ongoing SLA cycle with startTime, breachTime, breached, paused, withinCalendarHours, goalDuration, elapsedTime, remainingTime totalnumber Total number of SLAs isLastPageboolean Whether this is the last page
Get available transitions for a service request in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key transitionsarray List of available transitions ↳ id string Transition ID ↳ name string Transition name totalnumber Total number of transitions isLastPageboolean Whether this is the last page
Transition a service request to a new status in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) transitionIdstring Yes Transition ID to apply commentstring No Optional comment to add during transition
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key transitionIdstring Applied transition ID successboolean Whether the transition was successful
Get participants for a request in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key participantsarray List of participants ↳ accountId string Atlassian account ID ↳ displayName string Display name ↳ emailAddress string Email address ↳ active boolean Whether the account is active totalnumber Total number of participants isLastPageboolean Whether this is the last page
Add participants to a request in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) accountIdsstring Yes Comma-separated account IDs to add as participants
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key participantsarray List of added participants ↳ accountId string Atlassian account ID ↳ displayName string Display name ↳ emailAddress string Email address ↳ active boolean Whether the account is active successboolean Whether the operation succeeded
Get approvals for a request in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) startnumber No Start index for pagination (e.g., 0, 50, 100) limitnumber No Maximum results to return (e.g., 10, 25, 50)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key approvalsarray List of approvals ↳ id string Approval ID ↳ name string Approval description ↳ finalDecision string Final decision: pending, approved, or declined ↳ canAnswerApproval boolean Whether current user can respond ↳ approvers array List of approvers with their decisions ↳ approver object Approver user details ↳ accountId string Atlassian account ID ↳ displayName string User display name ↳ emailAddress string User email address ↳ active boolean Whether the account is active ↳ approverDecision string Decision: pending, approved, or declined ↳ createdDate json Creation date ↳ completedDate json Completion date totalnumber Total number of approvals isLastPageboolean Whether this is the last page
Approve or decline an approval request in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., SD-123) approvalIdstring Yes Approval ID to answer decisionstring Yes Decision: "approve" or "decline"
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key approvalIdstring Approval ID decisionstring Decision made (approve/decline) idstring Approval ID from response namestring Approval description finalDecisionstring Final approval decision: pending, approved, or declined canAnswerApprovalboolean Whether the current user can still respond approversarray Updated list of approvers with decisions ↳ approver object Approver user details ↳ accountId string Approver account ID ↳ displayName string Approver display name ↳ emailAddress string Approver email ↳ active boolean Whether the account is active ↳ approverDecision string Individual approver decision createdDatejson Approval creation date completedDatejson Approval completion date approvaljson The approval object successboolean Whether the operation succeeded
Get the fields required to create a request of a specific type in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) serviceDeskIdstring Yes Service Desk ID (e.g., "1", "2") requestTypeIdstring Yes Request Type ID (e.g., "10", "15")
Parameter Type Description tsstring Timestamp of the operation serviceDeskIdstring Service desk ID requestTypeIdstring Request type ID canAddRequestParticipantsboolean Whether participants can be added to requests of this type canRaiseOnBehalfOfboolean Whether requests can be raised on behalf of another user requestTypeFieldsarray List of fields for this request type ↳ fieldId string Field identifier (e.g., summary, description, customfield_10010) ↳ name string Human-readable field name ↳ description string Help text for the field ↳ required boolean Whether the field is required ↳ visible boolean Whether the field is visible ↳ validValues json Allowed values for select fields ↳ presetValues json Pre-populated values ↳ defaultValues json Default values for the field ↳ jiraSchema json Jira field schema with type, system, custom, customId
List forms (ProForma/JSM Forms) in a Jira project to discover form IDs for request types
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) projectIdOrKeystring Yes Jira project ID or key (e.g., "10001" or "SD")
Parameter Type Description tsstring Timestamp of the operation projectIdOrKeystring Project ID or key templatesarray List of forms in the project ↳ id string Form template ID (UUID) ↳ name string Form template name ↳ updated string Last updated timestamp (ISO 8601) ↳ issueCreateIssueTypeIds json Issue type IDs that auto-attach this form on issue create ↳ issueCreateRequestTypeIds json Request type IDs that auto-attach this form on issue create ↳ portalRequestTypeIds json Request type IDs that show this form on the customer portal ↳ recommendedIssueRequestTypeIds json Request type IDs that recommend this form totalnumber Total number of forms
Get the full structure of a ProForma/JSM form including all questions, field types, choices, layout, and conditions
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) projectIdOrKeystring Yes Jira project ID or key (e.g., "10001" or "SD") formIdstring Yes Form ID (UUID from Get Form Templates)
Parameter Type Description tsstring Timestamp of the operation projectIdOrKeystring Project ID or key formIdstring Form ID designjson Full form design with questions (field types, labels, choices, validation), layout (field ordering), and conditions updatedstring Last updated timestamp publishjson Publishing and request type configuration
List forms (ProForma/JSM Forms) attached to a Jira issue with metadata (name, submitted status, lock)
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., "SD-123", "10001")
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key formsarray List of forms attached to the issue ↳ id string Form instance ID (UUID) ↳ name string Form name ↳ updated string Last updated timestamp (ISO 8601) ↳ submitted boolean Whether the form has been submitted ↳ lock boolean Whether the form is locked ↳ internal boolean Whether the form is internal-only ↳ formTemplateId string Source form template ID (UUID) totalnumber Total number of forms
Attach a form template to an existing Jira issue or JSM request
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key to attach the form to (e.g., "SD-123") formTemplateIdstring Yes Form template UUID (from Get Form Templates)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key idstring Attached form instance ID (UUID) namestring Form name updatedstring Last updated timestamp submittedboolean Whether the form has been submitted lockboolean Whether the form is locked internalboolean Whether the form is internal only formTemplateIdstring Form template ID
Save answers to a form attached to a Jira issue or JSM request
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., "SD-123") formIdstring Yes Form instance UUID (from Attach Form or Get Issue Forms) answersjson Yes Form answers using numeric question IDs as keys (e.g., {"1": {"text": "Title"}, "4": {"choices": ["5"]}})
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key formIdstring Form instance UUID statejson Form state with status (open, submitted, locked) updatedstring Last updated timestamp
Submit a form on a Jira issue or JSM request, locking it from further edits
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., "SD-123") formIdstring Yes Form instance UUID (from Attach Form or Get Issue Forms)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key formIdstring Form instance UUID statusstring Form status after submission (open, submitted, locked)
Get a single form with full design, state, and answers from a Jira issue
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., "SD-123") formIdstring Yes Form instance UUID (from Attach Form or Get Issue Forms)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key formIdstring Form instance UUID designjson Full form design with questions, layout, conditions, sections, settings statejson Form state with answers map, status (o=open, s=submitted, l=locked), visibility (i=internal, e=external) updatedstring Last updated timestamp
Get simplified answers from a form attached to a Jira issue or JSM request
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., "SD-123") formIdstring Yes Form instance UUID (from Attach Form or Get Issue Forms)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key formIdstring Form instance UUID answersjson Simplified form answers as key-value pairs (question label to answer text/choices)
Reopen a submitted form on a Jira issue or JSM request, allowing further edits
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., "SD-123") formIdstring Yes Form instance UUID (from Get Issue Forms)
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key formIdstring Form instance UUID statusstring Form status after reopening (open, submitted, locked)
Remove a form from a Jira issue or JSM request
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., "SD-123") formIdstring Yes Form instance UUID to delete
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key formIdstring Deleted form instance UUID deletedboolean Whether the form was successfully deleted
Make a form visible to customers on a Jira issue or JSM request
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., "SD-123") formIdstring Yes Form instance UUID
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key formIdstring Form instance UUID visibilitystring Form visibility after change (internal or external)
Make a form internal only (not visible to customers) on a Jira issue or JSM request
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) issueIdOrKeystring Yes Issue ID or key (e.g., "SD-123") formIdstring Yes Form instance UUID
Parameter Type Description tsstring Timestamp of the operation issueIdOrKeystring Issue ID or key formIdstring Form instance UUID visibilitystring Form visibility after change (internal or external)
Copy forms from one Jira issue to another
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) sourceIssueIdOrKeystring Yes Source issue ID or key to copy forms from (e.g., "SD-123") targetIssueIdOrKeystring Yes Target issue ID or key to copy forms to (e.g., "SD-456") formIdsjson No Optional JSON array of form UUIDs to copy (e.g., ["uuid1", "uuid2"]). If omitted, copies all forms.
Parameter Type Description tsstring Timestamp of the operation sourceIssueIdOrKeystring Source issue ID or key targetIssueIdOrKeystring Target issue ID or key copiedFormsjson Array of successfully copied forms errorsjson Array of errors encountered during copy
List Assets (Insight/CMDB) object schemas in Jira Service Management
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) workspaceIdstring No Assets workspace ID (resolved automatically when omitted) startAtnumber No Pagination start index (e.g., 0, 50) maxResultsnumber No Maximum schemas to return (e.g., 25, 50) includeCountsboolean No Include object and object-type counts per schema
Parameter Type Description tsstring Timestamp of the operation schemasarray List of Assets object schemas ↳ id string Schema ID ↳ name string Schema name ↳ objectSchemaKey string Schema key ↳ status string Schema status ↳ description string Schema description ↳ objectCount number Number of objects ↳ objectTypeCount number Number of object types totalnumber Total number of schemas isLastboolean Whether this is the last page
Get a single Assets (Insight/CMDB) object schema by ID
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) workspaceIdstring No Assets workspace ID (resolved automatically when omitted) schemaIdstring Yes The Assets object schema ID
Parameter Type Description tsstring Timestamp of the operation schemajson The Assets object schema ↳ id string Schema ID ↳ name string Schema name ↳ objectSchemaKey string Schema key ↳ status string Schema status ↳ description string Schema description ↳ objectCount number Number of objects ↳ objectTypeCount number Number of object types
List object types within an Assets (Insight/CMDB) object schema
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) workspaceIdstring No Assets workspace ID (resolved automatically when omitted) schemaIdstring Yes The Assets object schema ID to list object types for excludeAbstractboolean No Exclude abstract object types from the result
Parameter Type Description tsstring Timestamp of the operation objectTypesarray List of object types in the schema ↳ id string Object type ID ↳ name string Object type name ↳ description string Object type description ↳ objectSchemaId string Parent schema ID ↳ objectCount number Number of objects ↳ abstractObjectType boolean Whether the type is abstract ↳ inherited boolean Whether the type inherits attributes totalnumber Total number of object types
Get the attribute definitions for an Assets (Insight/CMDB) object type. Use the returned attribute IDs to build create/update payloads or map columns.
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) workspaceIdstring No Assets workspace ID (resolved automatically when omitted) objectTypeIdstring Yes The Assets object type ID onlyValueEditableboolean No Return only attributes whose values can be edited querystring No Filter attributes by a search query
Parameter Type Description tsstring Timestamp of the operation attributesarray Attribute definitions for the object type ↳ id string Attribute definition ID — use as objectTypeAttributeId in create/update ↳ name string Attribute name ↳ label boolean Whether this attribute is the object label ↳ type number Data type discriminator (integer enum) ↳ defaultType json Default data type { id, name } ↳ editable boolean Whether the value is editable ↳ minimumCardinality number Minimum number of values (>= 1 means required) ↳ maximumCardinality number Maximum number of values ↳ uniqueAttribute boolean Whether values must be unique totalnumber Total number of attributes
Search Assets (Insight/CMDB) objects using AQL (Assets Query Language), e.g. objectType = "Host" AND Status = "Running". Supports pagination.
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) workspaceIdstring No Assets workspace ID (resolved automatically when omitted) qlQuerystring Yes AQL query string (e.g., objectType = "Host" AND "Operating System" = "Ubuntu") pagenumber No Page number (1-based, defaults to 1) resultsPerPagenumber No Results per page (e.g., 25, 50) includeAttributesboolean No Include resolved attribute values on each object (defaults to true) objectTypeIdstring No Optionally scope the search to a single object type ID objectSchemaIdstring No Optionally scope the search to a single object schema ID
Parameter Type Description tsstring Timestamp of the operation objectsarray Matching Assets objects ↳ id string Object ID ↳ label string Object label ↳ objectKey string Object key (e.g., HOST-123) ↳ objectType json Object type metadata ↳ attributes json Resolved attribute values totalnumber Total number of matching objects (totalFilterCount) pageNumbernumber Current page number pageSizenumber Number of objects on this page
Get a single Assets (Insight/CMDB) object by ID, including its attribute values
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) workspaceIdstring No Assets workspace ID (resolved automatically when omitted) objectIdstring Yes The Assets object ID
Parameter Type Description tsstring Timestamp of the operation objectjson The Assets object ↳ id string Object ID ↳ label string Human-readable object label ↳ objectKey string Object key (e.g., HOST-123) ↳ globalId string Global object ID ↳ objectType json Object type metadata ↳ attributes json Resolved attribute values for the object ↳ hasAvatar boolean Whether the object has an avatar ↳ created string Creation timestamp ↳ updated string Last update timestamp ↳ link string Self link to the object
Create an Assets (Insight/CMDB) object of a given object type. Attributes use objectTypeAttributeId values from the object type definition.
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) workspaceIdstring No Assets workspace ID (resolved automatically when omitted) objectTypeIdstring Yes The object type ID to create the object under attributesjson Yes Array of attributes: [{ objectTypeAttributeId, objectAttributeValues: [{ value }] }]
Parameter Type Description tsstring Timestamp of the operation objectjson The created Assets object ↳ id string Object ID ↳ label string Human-readable object label ↳ objectKey string Object key (e.g., HOST-123) ↳ globalId string Global object ID ↳ objectType json Object type metadata ↳ attributes json Resolved attribute values for the object ↳ hasAvatar boolean Whether the object has an avatar ↳ created string Creation timestamp ↳ updated string Last update timestamp ↳ link string Self link to the object
Update an existing Assets (Insight/CMDB) object. Provide the attributes to change using their objectTypeAttributeId values.
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) workspaceIdstring No Assets workspace ID (resolved automatically when omitted) objectIdstring Yes The Assets object ID to update attributesjson Yes Array of attributes to set: [{ objectTypeAttributeId, objectAttributeValues: [{ value }] }] objectTypeIdstring No Optional object type ID (only if changing the type)
Parameter Type Description tsstring Timestamp of the operation objectjson The updated Assets object ↳ id string Object ID ↳ label string Human-readable object label ↳ objectKey string Object key (e.g., HOST-123) ↳ globalId string Global object ID ↳ objectType json Object type metadata ↳ attributes json Resolved attribute values for the object ↳ hasAvatar boolean Whether the object has an avatar ↳ created string Creation timestamp ↳ updated string Last update timestamp ↳ link string Self link to the object
Delete an Assets (Insight/CMDB) object by ID
Inputs and outputsParameter Type Required Description domainstring Yes Your Jira domain (e.g., yourcompany.atlassian.net) workspaceIdstring No Assets workspace ID (resolved automatically when omitted) objectIdstring Yes The Assets object ID to delete
Parameter Type Description tsstring Timestamp of the operation objectIdstring The deleted object ID deletedboolean Whether the object was deleted
A trigger starts a workflow when a supported event occurs in this service.
Trigger workflow when a comment is added to a Jira Service Management request
Configuration and outputsParameter Type Required Description webhookSecretstring No Optional secret to validate webhook deliveries from Jira using HMAC signature jqlFilterstring No Filter which service desk requests trigger this workflow using JQL (Jira Query Language)
Parameter Type Description webhookEventstring The webhook event type (e.g., jira:issue_created, jira:issue_updated, comment_created) timestampnumber Timestamp of the webhook event userobject ↳ displayName string Display name of the user who triggered the event ↳ accountId string Account ID of the user who triggered the event issueobject ↳ id string Jira issue ID ↳ key string Issue key (e.g., SD-123) ↳ self string REST API URL for this issue ↳ fields object ↳ summary string Request summary/title ↳ status object ↳ name string Current status name ↳ id string Status ID ↳ statusCategory json Status category information ↳ priority object ↳ name string Priority name ↳ id string Priority ID ↳ issuetype object ↳ name string Issue type name (e.g., Service Request, Incident) ↳ id string Issue type ID ↳ project object ↳ key string Project key ↳ name string Project name ↳ id string Project ID ↳ reporter object ↳ displayName string Reporter display name ↳ accountId string Reporter account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ assignee object ↳ displayName string Assignee display name ↳ accountId string Assignee account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ creator object ↳ displayName string Creator display name ↳ accountId string Creator account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ created string Request creation date (ISO format) ↳ updated string Last updated date (ISO format) ↳ duedate string Due date for the request ↳ labels array Array of labels applied to this request ↳ resolution object ↳ name string Resolution name (e.g., Done, Fixed) ↳ id string Resolution ID commentobject ↳ id string Comment ID ↳ body json Comment body in Atlassian Document Format (ADF). On Jira Server this may be a plain string. ↳ author object ↳ displayName string Comment author display name ↳ accountId string Comment author account ID ↳ emailAddress string Comment author email address ↳ updateAuthor object ↳ displayName string Display name of the user who last updated the comment ↳ accountId string Account ID of the user who last updated the comment ↳ created string Comment creation date (ISO format) ↳ updated string Comment last updated date (ISO format)
Trigger workflow when a new service request is created in Jira Service Management
Configuration and outputsParameter Type Required Description webhookSecretstring No Optional secret to validate webhook deliveries from Jira using HMAC signature jqlFilterstring No Filter which service desk requests trigger this workflow using JQL (Jira Query Language)
Parameter Type Description webhookEventstring The webhook event type (e.g., jira:issue_created, jira:issue_updated, comment_created) timestampnumber Timestamp of the webhook event userobject ↳ displayName string Display name of the user who triggered the event ↳ accountId string Account ID of the user who triggered the event issueobject ↳ id string Jira issue ID ↳ key string Issue key (e.g., SD-123) ↳ self string REST API URL for this issue ↳ fields object ↳ summary string Request summary/title ↳ status object ↳ name string Current status name ↳ id string Status ID ↳ statusCategory json Status category information ↳ priority object ↳ name string Priority name ↳ id string Priority ID ↳ issuetype object ↳ name string Issue type name (e.g., Service Request, Incident) ↳ id string Issue type ID ↳ project object ↳ key string Project key ↳ name string Project name ↳ id string Project ID ↳ reporter object ↳ displayName string Reporter display name ↳ accountId string Reporter account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ assignee object ↳ displayName string Assignee display name ↳ accountId string Assignee account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ creator object ↳ displayName string Creator display name ↳ accountId string Creator account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ created string Request creation date (ISO format) ↳ updated string Last updated date (ISO format) ↳ duedate string Due date for the request ↳ labels array Array of labels applied to this request ↳ resolution object ↳ name string Resolution name (e.g., Done, Fixed) ↳ id string Resolution ID issue_event_type_namestring Issue event type name from Jira
Trigger workflow when a service request is resolved in Jira Service Management
Configuration and outputsParameter Type Required Description webhookSecretstring No Optional secret to validate webhook deliveries from Jira using HMAC signature jqlFilterstring No Filter which service desk requests trigger this workflow using JQL (Jira Query Language)
Parameter Type Description webhookEventstring The webhook event type (e.g., jira:issue_created, jira:issue_updated, comment_created) timestampnumber Timestamp of the webhook event userobject ↳ displayName string Display name of the user who triggered the event ↳ accountId string Account ID of the user who triggered the event issueobject ↳ id string Jira issue ID ↳ key string Issue key (e.g., SD-123) ↳ self string REST API URL for this issue ↳ fields object ↳ summary string Request summary/title ↳ status object ↳ name string Current status name ↳ id string Status ID ↳ statusCategory json Status category information ↳ priority object ↳ name string Priority name ↳ id string Priority ID ↳ issuetype object ↳ name string Issue type name (e.g., Service Request, Incident) ↳ id string Issue type ID ↳ project object ↳ key string Project key ↳ name string Project name ↳ id string Project ID ↳ reporter object ↳ displayName string Reporter display name ↳ accountId string Reporter account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ assignee object ↳ displayName string Assignee display name ↳ accountId string Assignee account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ creator object ↳ displayName string Creator display name ↳ accountId string Creator account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ created string Request creation date (ISO format) ↳ updated string Last updated date (ISO format) ↳ duedate string Due date for the request ↳ labels array Array of labels applied to this request ↳ resolution object ↳ name string Resolution name (e.g., Done, Fixed) ↳ id string Resolution ID issue_event_type_namestring Issue event type name from Jira changelogobject ↳ id string Changelog ID
Trigger workflow when a service request is updated in Jira Service Management
Configuration and outputsParameter Type Required Description webhookSecretstring No Optional secret to validate webhook deliveries from Jira using HMAC signature jqlFilterstring No Filter which service desk requests trigger this workflow using JQL (Jira Query Language)
Parameter Type Description webhookEventstring The webhook event type (e.g., jira:issue_created, jira:issue_updated, comment_created) timestampnumber Timestamp of the webhook event userobject ↳ displayName string Display name of the user who triggered the event ↳ accountId string Account ID of the user who triggered the event issueobject ↳ id string Jira issue ID ↳ key string Issue key (e.g., SD-123) ↳ self string REST API URL for this issue ↳ fields object ↳ summary string Request summary/title ↳ status object ↳ name string Current status name ↳ id string Status ID ↳ statusCategory json Status category information ↳ priority object ↳ name string Priority name ↳ id string Priority ID ↳ issuetype object ↳ name string Issue type name (e.g., Service Request, Incident) ↳ id string Issue type ID ↳ project object ↳ key string Project key ↳ name string Project name ↳ id string Project ID ↳ reporter object ↳ displayName string Reporter display name ↳ accountId string Reporter account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ assignee object ↳ displayName string Assignee display name ↳ accountId string Assignee account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ creator object ↳ displayName string Creator display name ↳ accountId string Creator account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ created string Request creation date (ISO format) ↳ updated string Last updated date (ISO format) ↳ duedate string Due date for the request ↳ labels array Array of labels applied to this request ↳ resolution object ↳ name string Resolution name (e.g., Done, Fixed) ↳ id string Resolution ID issue_event_type_namestring Issue event type name from Jira changelogobject ↳ id string Changelog ID
Trigger workflow on any Jira Service Management webhook event
Configuration and outputsParameter Type Required Description webhookSecretstring No Optional secret to validate webhook deliveries from Jira using HMAC signature jqlFilterstring No Filter which service desk requests trigger this workflow using JQL (Jira Query Language)
Parameter Type Description webhookEventstring The webhook event type (e.g., jira:issue_created, jira:issue_updated, comment_created) timestampnumber Timestamp of the webhook event userobject ↳ displayName string Display name of the user who triggered the event ↳ accountId string Account ID of the user who triggered the event issueobject ↳ id string Jira issue ID ↳ key string Issue key (e.g., SD-123) ↳ self string REST API URL for this issue ↳ fields object ↳ summary string Request summary/title ↳ status object ↳ name string Current status name ↳ id string Status ID ↳ statusCategory json Status category information ↳ priority object ↳ name string Priority name ↳ id string Priority ID ↳ issuetype object ↳ name string Issue type name (e.g., Service Request, Incident) ↳ id string Issue type ID ↳ project object ↳ key string Project key ↳ name string Project name ↳ id string Project ID ↳ reporter object ↳ displayName string Reporter display name ↳ accountId string Reporter account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ assignee object ↳ displayName string Assignee display name ↳ accountId string Assignee account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ creator object ↳ displayName string Creator display name ↳ accountId string Creator account ID ↳ emailAddress string Email address (Jira Server only — not available in Jira Cloud webhook payloads) ↳ created string Request creation date (ISO format) ↳ updated string Last updated date (ISO format) ↳ duedate string Due date for the request ↳ labels array Array of labels applied to this request ↳ resolution object ↳ name string Resolution name (e.g., Done, Fixed) ↳ id string Resolution ID issue_event_type_namestring Issue event type name from Jira changelogobject ↳ id string Changelog ID commentobject ↳ id string Comment ID ↳ body json Comment body in Atlassian Document Format (ADF). On Jira Server this may be a plain string. ↳ author object ↳ displayName string Comment author display name ↳ accountId string Comment author account ID ↳ emailAddress string Comment author email address ↳ created string Comment creation date (ISO format) ↳ updated string Comment last updated date (ISO format)