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

# Compound Actions

> Create, read and update compound actions through the Moveworks Configuration API.

`platform.extensions.compound-actions`

A compound action runs several steps without the user in the loop: actions, scripts, branches, loops and parallel steps. Use it for orchestration, and for the body of a system plugin.

To learn what compound actions do, see [Compound Actions](/tool-studio/actions/compound-actions) in the Tool Studio docs.

* **Endpoint:** `/platform/extensions/compound-actions`  |  **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 with `version: {num, change_description}` from your last read. Lists of objects merge row by row, so read first and send the whole list when you remove or reorder rows. See [Tool Studio](/api-reference/configuration-api/tool-studio/overview#how-updates-work).
* **References:** Steps in `workflow_steps` call actions by their `signature.name`. Plugins and conversational processes call the compound action by its `id`.

### 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`   | `/platform/extensions/compound-actions`      | [List compound actions](/api-reference/configuration-api/tool-studio/compound-actions/list-compound-actions)   |
| `POST`  | `/platform/extensions/compound-actions`      | [Create compound action](/api-reference/configuration-api/tool-studio/compound-actions/create-compound-action) |
| `GET`   | `/platform/extensions/compound-actions/{id}` | [Get compound action](/api-reference/configuration-api/tool-studio/compound-actions/get-compound-action)       |
| `PATCH` | `/platform/extensions/compound-actions/{id}` | [Update compound action](/api-reference/configuration-api/tool-studio/compound-actions/update-compound-action) |

### Rules the API checks

* `signature.name` is unique in your organization.
* Send `workflow_steps` (JSON) or `workflow_steps_yaml` (write-only), never both.
* Every `action_name` in a step must be the `signature.name` of an existing action or a built-in action such as `get_user_by_email`.
* A step's output is available to later steps as `data.<output_key>`.

### Fields

| Field                 | Type                      | Required  | Notes                                                                                                                                                    |
| --------------------- | ------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                  | string                    | read-only | Unique identifier of the compound action, assigned by the server.                                                                                        |
| `signature`           | FunctionSignatureSettings | ✅         | The compound action's callable contract. Its name is the key other compound actions call it by, and must be unique. Required.                            |
| `workflow_steps`      | object                    |           | Step tree in compound action syntax, as JSON. Do not send together with workflow_steps_yaml. An update that includes it replaces the whole tree.         |
| `workflow_steps_yaml` | string                    |           | The same step tree as YAML text, as written in the Tool Studio editor. Write-only; never returned. Do not send together with workflow_steps. Up to 1 MB. |
| `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
{
  "signature": {
    "name": "notify_ticket_closed",
    "display_name": "Notify Ticket Closed",
    "description": "Tells the requester their ticket was closed.",
    "arguments": [
      {
        "name": "requester_email",
        "description": "Requester's email address.",
        "type": {
          "primitive": "string"
        },
        "required": true
      },
      {
        "name": "ticket_id",
        "description": "The closed ticket's id.",
        "type": {
          "primitive": "string"
        },
        "required": true
      }
    ]
  },
  "workflow_steps": {
    "steps": [
      {
        "action": {
          "action_name": "get_user_by_email",
          "input_args": {
            "email": "data.requester_email"
          },
          "output_key": "requester"
        }
      },
      {
        "action": {
          "action_name": "send_plaintext_chat_notification",
          "input_args": {
            "user_record_id": "data.requester.user.record_id",
            "message": "$CONCAT([\"Your ticket \", data.ticket_id, \" has been closed.\"])"
          }
        }
      }
    ]
  },
  "version": {
    "change_description": "Initial version."
  }
}
```