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

# HTTP Actions

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

`platform.extensions.http-actions`

An HTTP action is one request to an external API through an HTTP connector: the method, the path, headers, query parameters and a request body built from the action's inputs.

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

* **Endpoint:** `/platform/extensions/http-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:** Uses an HTTP connector through `connector_id` (the connector's `id`). Conversational processes, data types and plugins refer to the action by its `id`; compound actions refer to it by `signature.name`.

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

### Rules the API checks

* `method` is required.
* `path` starts with `/` and has no query string. Use `{{{argument}}}` for path parameters and `query_params` for the query string.
* Up to 250 headers and 250 query parameters.
* `body_bender` takes the short form of a Data Mapper expression.

### Fields

| Field          | Type                       | Required  | Notes                                                                                                                                                                                      |
| -------------- | -------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`           | string                     | read-only | Unique identifier of the HTTP action, assigned by the server.                                                                                                                              |
| `signature`    | FunctionSignatureSettings  | ✅         | The action's callable contract: its name, description, input arguments and result schema. Required.                                                                                        |
| `connector_id` | string                     | ✅         | Connector that supplies the base URL and authentication for the request. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).                                   |
| `method`       | enum                       | ✅         | HTTP method the action calls. One of: GET, POST, PUT, DELETE, PATCH. Required on create. One of: `GET`, `POST`, `PUT`, `DELETE`, `PATCH`.                                                  |
| `path`         | string                     |           | Path appended to the connector's base URL, not a full URL. Must start with a slash and contain no query string. Use \{\{\{variable}}} for path parameters.                                 |
| `query_params` | array\<QueryParamSettings> |           | Query parameters appended to the request URL. Up to 250.                                                                                                                                   |
| `headers`      | array\<HttpHeaderSettings> |           | Request headers. Up to 250.                                                                                                                                                                |
| `body_bender`  | object                     |           | Request body as a Moveworks data mapper expression. An update that includes this field replaces the whole body.                                                                            |
| `file_bender`  | object                     |           | Files sent in the request, as a Moveworks data mapper resolving to \{argument_name: File / File\[]}, where File is \{filename, location}. Available to body_bender under the file keyword. |
| `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": "get_purchase_order",
    "display_name": "Get Purchase Order",
    "description": "Fetch a purchase order from the ERP by its PO number.",
    "arguments": [
      {
        "name": "po_number",
        "description": "The purchase order number, e.g. PO-1024.",
        "type": {
          "primitive": "string"
        },
        "required": true,
        "example_value": "PO-1024"
      }
    ]
  },
  "connector_id": "6f1c9f0e-6e1a-4b39-9a1e-1c6d0f2b7a55",
  "method": "GET",
  "path": "/api/v1/purchase_orders/{{{po_number}}}",
  "headers": [
    {
      "key": "Accept",
      "value": "application/json"
    }
  ],
  "version": {
    "change_description": "Initial version."
  }
}
```