Forms Integration - Jira Service Desk
Overview
You use Moveworks Form Integration with Jira Service Desk to:
- Enable powerful automations, leveraging Automation for Jira (example).
- Trigger custom approval workflows in Jira Service Management.
- Structure inputs from your employees. Moveworks uses this internally to run our Covid Attestations!
To get started, follow this guide on Creating Jira Request Types.
Jira Service Management now offers two distinct ways to create intake forms for users: “Request Types” (the legacy feature) and “Forms” (the new feature released in late 2021, incorporated from Atlassian’s acquisition of the creator of the Proforma plugin). Request Types are currently supported by Moveworks for In-Bot Form Filling, while Forms currently are not.
See Form Filling for examples of how Request Types are rendered within Moveworks bot conversation.
Permissions Required
Moveworks needs the ability to hit the following {instance_url}/rest/servicedeskapi APIs in Jira for the service_desk_id that corresponds to your ServiceDesk project.
/servicedesk
/servicedesk/{service_desk_id}/requesttype
/servicedesk/{service_desk_id}/requesttype/{requesttype_id}/field
/servicedesk/{service_desk_id}/requesttypegroup
These endpoints require that your instance support setting the X-ExperimentalApi header to opt-in.
Form Ingestion
Moveworks will ingest all forms that are available within a ServiceDesk. If a form does not have any associated categories, Moveworks will mark that form as unavailable for ingestion.
Once the forms are ingested, Moveworks will link your employees to them by redirecting them to {jira_url}/servicedesk/customer/portal/{service_desk_id}/create/{request_type_id}
. This URL can not be configured today.
Unsupported Extensions
In December 2021, Jira Service Management acquired Proforma, a popular Marketplace plugin, and integrated Proforma’s functionality into their native product - presented as the Forms
feature. These forms are currently not supported for in-bot filling.
Jira Request Types that utilize Forms cannot be automatically detected through the API. Thus, if your organization leverages Forms in some of your Request Types, you should notify your Customer Success team so that these Request Types can be blocked from in-bot filling. They will still be redirected to the Jira Portal to be filled out.
Supported fields
Moveworks converts your Jira fields into internal supported types where possible.
Form Field Type Conversion
System | External Field Type | Moveworks Type |
---|---|---|
Jira Service Desk | description | Text: Single line |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes | Dropdown: Multiple |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect | Unsupported |
Jira Service Desk | description | Text: Multi-line |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:textfield | Text: Single line |
Jira Service Desk | summary | Text: Single line |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker | Dropdown: Multiple |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:float | Text: Single line |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:textarea | Text: Multi-line |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:multiselect | Dropdown: Multiple |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:labels | Unsupported |
Jira Service Desk | com.atlassian.servicedesk:sd-request-participants | Dropdown: Multiple |
Jira Service Desk | priority | Dropdown: Single |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:datetime | Datetime |
Jira Service Desk | Any custom plugin field type | Unsupported |
Jira Service Desk | components | Dropdown: Multiple |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:userpicker | Dropdown: Single |
Jira Service Desk | labels | Unsupported |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:select | Dropdown: Single |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons | Dropdown: Single |
Jira Service Desk | duedate | Date |
Jira Service Desk | com.atlassian.jira.plugin.system.customfieldtypes:url | Text: Single line |
Updated 9 months ago