Sign inGet started
Docs
Get started

LiveChat API Authentication

How to authenticate LiveChat API requests: one Bearer API key plus a connectionId. MindCloud stores your LiveChat credentials — no auth headers to build.

Every LiveChat API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your LiveChat account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a LiveChat connection in Connections. LiveChat uses a username and password. You enter them when you create the connection — MindCloud stores them securely so your requests never carry raw credentials.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected LiveChat account that should run the action. MindCloud stores and refreshes the LiveChat credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Chats with an LiveChat connection looks like this:

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": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which LiveChat account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Set up your LiveChat Personal Access Token

You need access to the Text Developer Console and the LiveChat scopes required for the actions you want this wrapper to run.

  1. Open the Developer Console

    Go to the Text Developer Console, then open Settings > Authorization > Personal Access Tokens.

    Settings → Authorization → Personal Access Tokens
  2. Create a new Personal Access Token

    Create a PAT and include every scope required by the LiveChat actions you want to use. For this wrapper's frozen action set, that includes chat read/write scopes, customer read/write scopes, and routing-status scopes. The docs note that you cannot change PAT scopes after the token is created.

  3. Use your LiveChat account ID as the username

    For Agent Chat API v3, the docs require Account ID as the username and PAT as the password. Do not use your legacy login or entity ID for this API version.

  4. Enter the credentials in MindCloud

    Paste your LiveChat account ID into the Username field and your PAT into the Password field. MindCloud will generate the Basic Authorization header automatically, so you do not need to paste a pre-encoded base64 string into the form.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.