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

# Plugins

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

`platform.extensions.plugins`

A plugin is what the assistant runs. A conversational plugin is triggered by what users say and launches a conversational process. A system plugin is triggered by a webhook listener, a schedule or a built-in event, and runs an action.

To learn what plugins do, see [Plugins](/tool-studio/plugins) in the Tool Studio docs.

* **Endpoint:** `/platform/extensions/plugins`  |  **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:** A conversational plugin takes the process's `id` in `execution_config.conversational_plugin_body_config_uuid`. A system plugin takes an action `id` in `execution_config.system_plugin_body_config.action_id`, and a listener's `id` in each event subscription's `listener_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/plugins`      | [List plugins](/api-reference/configuration-api/tool-studio/plugins/list-plugins)   |
| `POST`  | `/platform/extensions/plugins`      | [Create plugin](/api-reference/configuration-api/tool-studio/plugins/create-plugin) |
| `GET`   | `/platform/extensions/plugins/{id}` | [Get plugin](/api-reference/configuration-api/tool-studio/plugins/get-plugin)       |
| `PATCH` | `/platform/extensions/plugins/{id}` | [Update plugin](/api-reference/configuration-api/tool-studio/plugins/update-plugin) |

### Rules the API checks

* Use `custom_triggering_config` (conversational) or `system_triggering_config` (system), not both.
* A conversational plugin needs at least 5 `positive_triggering_examples` and a `launch_config.user_allow_list_config` with exactly one of `allow_all`, `allow_emails`, `block_emails` or `allowlist_rule`.
* A system plugin has exactly one trigger: one event subscription, one schedule or one built-in trigger.
* To pilot a plugin, set `allow_emails` to the people testing it, then update it to `{"allow_all": true}`.

### Fields

| Field               | Type                    | Required  | Notes                                                                                                                                                    |
| ------------------- | ----------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `basic_info`        | UseCaseBasicInfo        | ✅         | Name and description of the plugin, as shown to users.                                                                                                   |
| `launch_config`     | UseCaseLaunchConfig     |           | Who can use the plugin, whether analytics are enabled, and how logs are redacted. If omitted, analytics are disabled and standard log redaction is used. |
| `triggering_config` | UseCaseTriggeringConfig | ✅         | What triggers the plugin. Set exactly one of custom_triggering_config or system_triggering_config.                                                       |
| `execution_config`  | UseCaseExecutionConfig  | ✅         | What the plugin runs. Must match the trigger: conversational triggers run a conversational process; system triggers run an action.                       |
| `id`                | string                  | read-only | Unique identifier of the plugin, assigned by the server.                                                                                                 |
| `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
{
  "basic_info": {
    "name": "Purchase Order Lookup",
    "description": "Looks up a purchase order and reports its status."
  },
  "launch_config": {
    "user_allow_list_config": {
      "allow_emails": {
        "values": [
          "jordan.lee@example.com"
        ]
      }
    },
    "enable_analytics": true
  },
  "triggering_config": {
    "custom_triggering_config": {
      "positive_triggering_examples": [
        "where is my purchase order",
        "check the status of PO-1024",
        "has my PO been approved yet",
        "look up purchase order PO-2231",
        "what happened to my purchase order"
      ],
      "negative_triggering_examples": [
        "create a new purchase order",
        "cancel my purchase order",
        "list all purchase orders for my team"
      ]
    }
  },
  "execution_config": {
    "conversational_plugin_body_config_uuid": "0f36c4e2-9a0f-4d21-8e0e-3a9c2f6b1d77"
  },
  "version": {
    "change_description": "Initial version."
  }
}
```