Skip to navigation

Ticket Workflows

View as Markdown

tool.ticket.workflows

Named action flows. display_name is the runtime identifier — a name colliding with a shipped {SYSTEM}_MW_DEFAULT_* workflow replaces it.

  • Endpoint: /tool/ticket/workflows | 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/workflowsList ticket workflows
POST/tool/ticket/workflowsCreate ticket workflow
GET/tool/ticket/workflows/{id}Get ticket workflow
PATCH/tool/ticket/workflows/{id}Update ticket workflow

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
display_namestring✅A readable name for the workflow.
connector_idstringThe connector this workflow’s actions run against. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
conditional_actionsarray<TicketWorkflowConditionalActionSettings>Groups of actions that run when their condition matches.
default_actionTicketWorkflowDefaultActionSettingsThe actions that run when no conditional action matches.
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

{
"display_name": "example-name",
"connector_id": "<connector-uuid>",
"conditional_actions": [
{
"condition_dsl": "true",
"actions": [
{
"create_ticket_action": {}
}
]
}
],
"default_action": {
"actions": [
{
"create_ticket_action": {}
}
]
},
"version": {
"change_description": "Create ticket workflow"
}
}