Skip to navigation

Ticket Actions

View as Markdown

tool.ticket.action

In-bot ticket actions and display behaviour.

  • Endpoint: /tool/ticket/action | Methods: GET, PATCH
  • Request shape: one per organization, so there is no id. It already exists: read it with GET, then PATCH the fields you want to change. Fields go at the top level of the JSON body, with no resource wrapper.
  • 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/actionGet ticket actions
PATCH/tool/ticket/actionUpdate ticket actions

Fields

FieldTypeRequiredNotes
ticket_displayTicketDisplaySettingsHow tickets are displayed to users in the assistant.
unsupported_ticket_typesarray<string>Ticket types the assistant does not support for checking status and other ticket actions. Allowed values: DEFAULT, INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE.
default_ticket_type_to_filestringTicket type that is always filed. DEFAULT lets Moveworks choose the type automatically. Allowed values: DEFAULT, INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE.
comment_capture_before_reopening_enabledbooleanIf true, users can add a comment before reopening a ticket.
askme_on_ticket_route_filter_dslstringMoveworks DSL rule selecting the users who receive AskMe reach-outs from a ticket.
ticket_interception_for_assistant_enabled_dslstringMoveworks DSL rule that turns on ticket interception in the AI Assistant for matching users.
attachment_upload_enabled_dslstringMoveworks DSL rule that offers users an option to upload attachments to add details to a ticket draft.
hide_reopen_button_if_ticket_state_is_closed_enabled_dslstringMoveworks DSL rule that, when it matches, hides the ‘Reopen Ticket’ button for tickets in the CLOSED state.
live_agent_enabled_dslstringMoveworks DSL rule that offers live agent handoff as an alternative to filing a ticket.
live_agent_link_enabled_dslstringMoveworks DSL rule that includes a live agent link in ticket comments.
ticket_handoff_history_passing_optionsTicketHandoffHistorySettingsHow conversation history is passed to the ticketing system when a ticket is filed.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument version. On update, send back the num from your last read.

Document fields (example)

The document as GET returns it. To change any of these, send only the fields you want to change in the PATCH body.

{
"ticket_display": {
"customer_ticket_state_display_enabled": true,
"assignee_display_enabled": true,
"ticket_link_to_reference_pop_up_enabled": true
},
"unsupported_ticket_types": [],
"default_ticket_type_to_file": "DEFAULT",
"comment_capture_before_reopening_enabled": true,
"askme_on_ticket_route_filter_dsl": "true",
"ticket_interception_for_assistant_enabled_dsl": "true",
"attachment_upload_enabled_dsl": "true",
"hide_reopen_button_if_ticket_state_is_closed_enabled_dsl": "true"
}