Manage live chat conversations, agents, and HelpDesk tickets in LiveChat via the LiveChat Configuration API, Agent Chat API, and HelpDesk API.

LiveChat

Manage live chat conversations, agents, and HelpDesk tickets in LiveChat using the LiveChat Agent Chat API (v3.6), Configuration API (v3.6), and HelpDesk API (v1).

What it does

Operation	API	Description
`list_chats`	Agent Chat	List chat summaries the agent has access to
`get_chat`	Agent Chat	Get a specific chat (and optionally a specific thread)
`send_message`	Agent Chat	Send a text message into an active chat thread
`list_agents`	Configuration	List all agents in the LiveChat license
`get_agent`	Configuration	Get details for a specific agent by login (email)
`list_tickets`	HelpDesk	List HelpDesk tickets
`get_ticket`	HelpDesk	Get a specific HelpDesk ticket by ID
`create_ticket`	HelpDesk	Create a new HelpDesk ticket

Authentication

LiveChat uses HTTP Basic authentication with a Personal Access Token (PAT).

Getting your credentials

Open the LiveChat Developer Console.
Go to Settings > Authorization > Personal Access Tokens.
Click Create token +, select the scopes you need (e.g. chats--all:ro, agents--all:ro), and save.
Copy both the Account ID and the Personal Access Token — you need both.

How auth works

The tool Base64-encodes {accountId}:{personalAccessToken} and sends it as:

Authorization: Basic <base64>

This is the same credential pair used across the Agent Chat API, Configuration API, and HelpDesk API.

Inputs

Input	Required	Description
`accountId`	Yes	LiveChat Account ID (shown next to your PAT in the Developer Console)
`apiKey`	Yes	LiveChat Personal Access Token
`operation`	Yes	One of the operations listed above
`chatId`	For `get_chat`, `send_message`	Chat ID
`threadId`	Required for `send_message`, optional for `get_chat`	Thread ID within the chat
`message`	For `send_message`	Text of the message to send
`agentId`	For `get_agent`	Agent login (email address)
`ticketId`	For `get_ticket`	HelpDesk ticket ID
`subject`	For `create_ticket`	Ticket subject line
`requesterEmail`	For `create_ticket`	Email address of the ticket requester
`ticketMessage`	For `create_ticket`	Opening message body for the ticket

Outputs

Output	Description
`result`	JSON response body from the LiveChat or HelpDesk API
`status`	HTTP status code as a string (e.g. `"200"`)

Examples

List active chats

- name: chats
  type: livechat
  input:
    accountId: "{{credential.livechat.accountId}}"
    apiKey: "{{credential.livechat.apiKey}}"
    operation: list_chats

Get a specific chat

- name: chat
  type: livechat
  input:
    accountId: "{{credential.livechat.accountId}}"
    apiKey: "{{credential.livechat.apiKey}}"
    operation: get_chat
    chatId: "PJ0MRSHTDG"

Send a message

- name: reply
  type: livechat
  input:
    accountId: "{{credential.livechat.accountId}}"
    apiKey: "{{credential.livechat.apiKey}}"
    operation: send_message
    chatId: "PJ0MRSHTDG"
    threadId: "K600PKZON8"
    message: "Thanks for reaching out! An agent will be with you shortly."

Create a HelpDesk ticket

- name: ticket
  type: livechat
  input:
    accountId: "{{credential.livechat.accountId}}"
    apiKey: "{{credential.livechat.apiKey}}"
    operation: create_ticket
    subject: "Cannot log in to account"
    requesterEmail: "[email protected]"
    ticketMessage: "I have been unable to log in since yesterday morning."

API References

Agent Chat API: https://platform.text.com/docs/messaging/agent-chat-api
Configuration API: https://platform.text.com/docs/management/configuration-api
HelpDesk API: https://api.helpdesk.com/docs
Personal Access Tokens: https://platform.text.com/docs/authorization/personal-access-tokens