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

# Approval Integrations

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

`tool.approval.integrations`

* **Endpoint:** `/tool/approval/integrations`  |  **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/approval/integrations`      | [List approval integrations](/api-reference/configuration-api/approvals/approval-integrations/list-approval-integrations)   |
| `POST`  | `/tool/approval/integrations`      | [Create approval integration](/api-reference/configuration-api/approvals/approval-integrations/create-approval-integration) |
| `GET`   | `/tool/approval/integrations/{id}` | [Get approval integration](/api-reference/configuration-api/approvals/approval-integrations/get-approval-integration)       |
| `PATCH` | `/tool/approval/integrations/{id}` | [Update approval integration](/api-reference/configuration-api/approvals/approval-integrations/update-approval-integration) |

### Fields

| Field              | Type                     | Required  | Notes                                                                                                                                                                                                                    |
| ------------------ | ------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`               | string                   | read-only | Unique identifier of this configuration, assigned by the server.                                                                                                                                                         |
| `connector_id`     | string                   | ✅         | The connector these approval settings apply to. Only one configuration can exist per connector, and it cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors). |
| `default_resource` | ApprovalResourceSettings |           | Default approval settings for all resource types from this connector. Resource-specific settings take precedence.                                                                                                        |
| `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
{
  "connector_id": "<connector-uuid>",
  "default_resource": {
    "resource_type": "REQUEST_ITEM",
    "buttons": [
      {
        "type": "approve",
        "display_info": {}
      }
    ],
    "link_strategy": {
      "template": {
        "url_template": "https://example.com/path"
      }
    },
    "mapper_bender": {},
    "augmenter_bender": {},
    "augmenting_data_retrievers": [
      {
        "ticket_approval_data_retriever": {}
      }
    ],
    "record_prefilter_dsl": "true",
    "notification_filter_dsl": "true",
    "external_resource_keys": [
      "<string>"
    ]
  },
  "version": {
    "change_description": "Create approval integration"
  }
}
```