Skip to navigation

Live Agent Integrations

View as Markdown

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

MethodPathEndpoint reference
GET/tool/live-agent/integrationsList live agent integrations
POST/tool/live-agent/integrationsCreate live agent integration
GET/tool/live-agent/integrations/{id}Get live agent integration
PATCH/tool/live-agent/integrations/{id}Update live agent integration

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of the handoff configuration, assigned by the server.
namestringUnique key used to refer to this handoff. Must start with a lowercase letter and contain only lowercase letters, digits and underscores. Cannot be changed after creation.
channelChannelHandoffConfigHands off by routing the user’s messages to a channel where agents respond.
apiApiHandoffConfigHands off through a live agent provider’s API, such as Vayusphere or BeyondTrust.
urlUrlHandoffConfigHands off by directing the user to a URL that connects them to an agent.
agent_brokerAgentBrokerHandoffConfigHands off by brokering the chat to a live agent provider, such as Amazon Connect, ServiceNow, Genesys or Salesforce.
file_ticket_enabledbooleanIf true, a ticket is automatically filed for the user whenever they request a live agent.
ticket_receipt_traitsAgentHandoffTicketTraitsAdditional settings for the ticket filed when a user requests a live agent.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

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.

FieldTypeRequiredNotes
routesarray<ChannelRouteConfig>✅Channels the user’s messages can be routed to. Between 1 and 20 routes.

api

Hands off through a live agent provider’s API, such as Vayusphere or BeyondTrust.

FieldTypeRequiredNotes
vayusphereVayusphereLiveAgentApiHandoffConfigHands off to a live agent queue through the Vayusphere API.
beyond_trustBeyondTrustApiHandoffConfigHands off to a live agent session through the BeyondTrust API.

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.

FieldTypeRequiredNotes
base_urlstringBase URL that connects the user to an agent. Must start with http:// or https:// when set.
user_comment_collection_enabledbooleanIf true, a comment is collected from the user and made available to the URL parameter mapper under the key ‘user_text’.
url_params_benderobjectData mapper that defines the URL parameters Moveworks adds to the handoff URL.
url_tracking_enabledbooleanIf true, the URL is wrapped as a Moveworks link so clicks are tracked in analytics. Not recommended for Microsoft Teams, where it opens a browser tab.

agent_broker

Hands off by brokering the chat to a live agent provider, such as Amazon Connect, ServiceNow, Genesys or Salesforce.

FieldTypeRequiredNotes
anonymous_agents_enabledbooleanIf true, the live agent provider uses anonymous agents.
amazon_connectAmazonConnectHandoffConfigSettings for brokering live agent chats to Amazon Connect.
eight_x_eightEightXEightHandoffConfigSettings for brokering live agent chats to 8x8.
snowSnowHandoffConfigSettings for brokering live agent chats to ServiceNow.
gliaGliaHandoffConfigSettings for brokering live agent chats to Glia.
fresh_chatFreshChatHandoffConfigSettings for brokering live agent chats to Freshchat.
five_nineFiveNineHandoffConfigSettings for brokering live agent chats to Five9.
genesysGenesysHandoffConfigSettings for brokering live agent chats to Genesys.
salesforceSalesforceHandoffConfigSettings for brokering live agent chats to Salesforce.
session_timeout_secondsintegerSeconds of inactivity after which a live agent session is automatically ended. Defaults to 120 seconds if not set.
connector_idstringConnector used to start the live agent connection. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

In agent_broker, set at most one of amazon_connect, eight_x_eight, snow, glia, fresh_chat, five_nine, genesys, salesforce.

Example create body

{
"name": "example",
"file_ticket_enabled": true,
"channel": {
"routes": [
{
"channel_id": "<id>",
"connector_id": "<connector-uuid>"
}
]
},
"version": {
"change_description": "Create live agent integration"
}
}