> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Ticket Workflows

> Create, read and update Ticket Workflows through the Moveworks Configuration API: endpoints, fields and examples.

`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.

| Method  | Path                          | Endpoint reference                                                                                           |
| ------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `GET`   | `/tool/ticket/workflows`      | [List ticket workflows](/api-reference/configuration-api/ticketing/ticket-workflows/list-ticket-workflows)   |
| `POST`  | `/tool/ticket/workflows`      | [Create ticket workflow](/api-reference/configuration-api/ticketing/ticket-workflows/create-ticket-workflow) |
| `GET`   | `/tool/ticket/workflows/{id}` | [Get ticket workflow](/api-reference/configuration-api/ticketing/ticket-workflows/get-ticket-workflow)       |
| `PATCH` | `/tool/ticket/workflows/{id}` | [Update ticket workflow](/api-reference/configuration-api/ticketing/ticket-workflows/update-ticket-workflow) |

### Fields

| Field                 | Type                                            | Required  | Notes                                                                                                                                                                |
| --------------------- | ----------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                  | string                                          | read-only | Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.                                           |
| `display_name`        | string                                          | ✅         | A readable name for the workflow.                                                                                                                                    |
| `connector_id`        | string                                          |           | The connector this workflow's actions run against. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors). |
| `conditional_actions` | array\<TicketWorkflowConditionalActionSettings> |           | Groups of actions that run when their condition matches.                                                                                                             |
| `default_action`      | TicketWorkflowDefaultActionSettings             |           | The actions that run when no conditional action matches.                                                                                                             |
| `updated_time`        | string                                          | read-only | When the configuration was last updated.                                                                                                                             |
| `updated_by`          | string                                          | read-only | Who last updated the configuration.                                                                                                                                  |
| `version`             | Version                                         | ✅         | Document version. On update, send back the num from your last read.                                                                                                  |

### Example create body

```json
{
  "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"
  }
}
```