LiveChat API Documentation

This is the complete API documentation for connecting to the LiveChat API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet LiveChat: Manage LiveChat chats, customers, routing, and messaging operations. Keep reading to get started.

Quickstart

Before you run your first LiveChat request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one LiveChat connection — create or choose one in Connections. Note its connectionId.

Every LiveChat action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/liveChat/actions/{actionSlug}/run

You need a MindCloud API Key and a LiveChat connection. Then call an action such as List Chats:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/liveChat/actions/list-chats/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your LiveChat account. See LiveChat API Authentication for the full flow and how to get your connection credentials.

LiveChat actions

All 24 published actions for this LiveChat version. Each page documents the endpoint, arguments, and response controls.

• PUTAdd User To Chat
• PUTDeactivate Chat
• PUTFollow Chat
• GETGet Chat
• GETGet Customer
• GETList Agents For Transfer
• GETList Archives
• GETList Chats
• GETList Routing Statuses
• GETList Threads
• PUTMark Events As Seen
• PUTRemove User From Chat
• POSTResume Chat
• POSTSend Event
• POSTSend Rich Message Postback
• PUTSet Routing Status
• POSTStart Chat
• PUTTag Thread
• PUTTransfer Chat
• PUTUnfollow Chat
• PUTUntag Thread
• PUTUpdate Chat Properties
• PUTUpdate Customer
• POSTUpload File

Related apps

More Support apps on the Universal API, behind the same REST shape. Or browse all apps.

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear