Skip to navigation

Ticket Integration Settings

View as Markdown

tool.ticket.integration.settings

The anchor record: registers one ITSM system. bot_sys_id must match the bot’s identity in identity-bot-account.itsm_id_info for this connector.

  • Endpoint: /tool/ticket/integration/settings | Methods: GET, PATCH, POST
  • Request shape: fields go at the top level of the JSON body, with no resource wrapper. The item’s id goes in the URL for reads and updates, not in the body.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/tool/ticket/integration/settingsList ticket integration settings
POST/tool/ticket/integration/settingsCreate ticket integration setting
GET/tool/ticket/integration/settings/{id}Get ticket integration setting
PATCH/tool/ticket/integration/settings/{id}Update ticket integration setting

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique ID of this configuration, assigned by the server.
connector_idstring✅Connector for the ticketing system these settings describe. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
project_namestringName of the project in the ticketing system, e.g. the Jira project.
namestring✅Friendly name for this ticketing system configuration.
primarybooleanIf true, this is the primary ticketing system. Only one configuration can be primary; setting this true unsets the previous primary.
bot_sys_idstring✅ID of the Moveworks bot service account in the ticketing system. Must match the external ID or ITSM user ID configured for that account in your identity settings. 1 to 64 characters.
concierge_ticket_typesarray<enum>Ticket types the assistant can poll for status checks and nudges. Allowed values: INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE. One of: INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE.
ticket_types_to_pollarray<enum>Ticket types polled so that assistant skills such as status checks, access requests, forms and triage can act on them. Allowed values: INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE. One of: INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE.
ticket_url_formatstringRedirect URL format for links users click to open a ticket in the portal.
ticket_actions_requiring_user_impersonationarray<enum>Ticket actions the bot performs by impersonating the user instead of acting on their behalf. Allowed values: ADD_COMMENT, REOPEN_TICKET, RESOLVE_TICKET. One of: ADD_COMMENT, REOPEN_TICKET, RESOLVE_TICKET.
service_portal_uristringPath of the service portal in the ticketing system, used to build links to portal pages (e.g. servicedesk/customer/portal).
service_portal_linksTicketServicePortalLinksSettingsLinks to service portal pages shown to users.
rtf_summary_formatstringFormat of the summary used for rich ticket filing in this ticketing system.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

Example create body

{
"connector_id": "<connector-uuid>",
"project_name": "example-name",
"name": "example-name",
"primary": true,
"bot_sys_id": "<id>",
"concierge_ticket_types": [],
"ticket_types_to_poll": [],
"ticket_url_format": "https://example.com/path",
"ticket_actions_requiring_user_impersonation": [],
"service_portal_uri": "https://example.com/path",
"service_portal_links": {
"all_tickets_url": "https://example.com/path"
},
"version": {
"change_description": "Create ticket integration setting"
}
}