Live Agent Integrations
tool.live-agent.integrations
One per live-agent channel; name (lowercase snake_case) is the join key from handoff items.
- Endpoint:
/tool/live-agent/integrations| Methods: GET, PATCH, POST - Request shape: fields go at the top level of the JSON body, with no
resourcewrapper. The item’sidgoes 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 thenumfrom 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.
Fields
Set at most one of channel, api, url, agent_broker.
Variants (4, pick one)
channel
Hands off by routing the user’s messages to a channel where agents respond.
api
Hands off through a live agent provider’s API, such as Vayusphere or BeyondTrust.
In api, set at most one of vayusphere, beyond_trust.
url
Hands off by directing the user to a URL that connects them to an agent.
agent_broker
Hands off by brokering the chat to a live agent provider, such as Amazon Connect, ServiceNow, Genesys or Salesforce.
In agent_broker, set at most one of amazon_connect, eight_x_eight, snow, glia, fresh_chat, five_nine, genesys, salesforce.