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

# Live Agent Message Broker

> Read and update Live Agent Message Broker through the Moveworks Configuration API: endpoints, fields and examples.

`tool.live-agent.message-broker`

In-bot chat (agent-broker) behaviour: availability hours (set both start AND end), history passing, CSAT.

* **Endpoint:** `/tool/live-agent/message-broker`  |  **Methods:** GET, PATCH
* **Request shape:** one per organization, so there is no `id`. It already exists: read it with `GET`, then `PATCH` the fields you want to change. Fields go at the top level of the JSON body, with no `resource` wrapper.
* **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/live-agent/message-broker` | [Get live agent message broker](/api-reference/configuration-api/handoff-live-agent/live-agent-message-broker/get-live-agent-message-broker)       |
| `PATCH` | `/tool/live-agent/message-broker` | [Update live agent message broker](/api-reference/configuration-api/handoff-live-agent/live-agent-message-broker/update-live-agent-message-broker) |

### Fields

| Field                                               | Type                           | Required  | Notes                                                                                                                                      |
| --------------------------------------------------- | ------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `agent_always_available_enabled`                    | boolean                        |           | If true, agents are always treated as available and availability is not fetched from the agent's system.                                   |
| `pre_chat_sys_msg_limit_enabled`                    | boolean                        |           | If true, limits the number of system messages sent to the user before an agent connects.                                                   |
| `pre_chat_sys_msg_limit`                            | integer                        |           | Maximum number of system messages sent to the user before an agent connects.                                                               |
| `agent_language`                                    | string                         |           | Language agents communicate in, as a two- or three-letter language code such as EN, ES or FR.                                              |
| `on_demand_machine_translation_enabled`             | boolean                        |           | If true, messages are translated on demand based on the user's locale and the agent's language.                                            |
| `transcript_date_format`                            | string                         |           | Date format used in live agent transcripts: ISO (YYYY/MM/DD), US (MM/DD/YYYY) or European (DD/MM/YYYY).                                    |
| `file_attachment_size_limit_enabled`                | boolean                        |           | If true, limits the size of a single file attachment.                                                                                      |
| `file_attachment_size_limit`                        | integer                        |           | Maximum file size, in MB, allowed for a single attachment.                                                                                 |
| `total_file_attachment_allowed_per_session_enabled` | boolean                        |           | If true, limits the number of attachments allowed per live agent session.                                                                  |
| `total_file_attachment_allowed_per_session`         | integer                        |           | Maximum number of attachments allowed per live agent session.                                                                              |
| `pass_chat_history_disabled`                        | boolean                        |           | If true, the chat history is not passed to the agent when the live agent chat starts.                                                      |
| `post_session_trigger_creator_studio_event_enabled` | boolean                        |           | If true, a custom event runs after the live agent session completes.                                                                       |
| `custom_event_uuid`                                 | string                         |           | Custom event that runs after the live agent session completes. ID of an existing EventConfig; not available through the Configuration API. |
| `history_passing_option`                            | LiveAgentHistoryPassingOptions |           | Options for how chat history is passed to the agent. Applies only when chat history passing is not disabled.                               |
| `live_agent_transcript_enabled_dsl`                 | string                         |           | Moveworks DSL rule for which users can download a plain-text transcript after a live agent chat. Use 'true' to enable for all users.       |
| `csat_webhook_action`                               | CSATWebhookAction              |           | Webhook action that runs after a live agent session ends to collect CSAT data.                                                             |
| `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.                                                                        |

### Document fields (example)

The document as `GET` returns it. To change any of these, send only the fields you want to change in the `PATCH` body.

```json
{
  "agent_always_available_enabled": true,
  "pre_chat_sys_msg_limit_enabled": true,
  "pre_chat_sys_msg_limit": 1,
  "agent_language": "AF",
  "on_demand_machine_translation_enabled": true,
  "transcript_date_format": "ISO",
  "file_attachment_size_limit_enabled": true,
  "file_attachment_size_limit": 1
}
```