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

Authentication

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

Getting your credentials

1. Open the LiveChat Developer Console.
2. Go to Settings > Authorization > Personal Access Tokens.
3. Click Create token +, select the scopes you need (e.g. chats--all:ro, agents--all:ro), and save.
4. 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

Outputs

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

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.