# LiveChat HITL Integration
This integration allows Botpress to use LiveChat as a HITL (Human in the Loop) provider. Messages from the bot will appear in LiveChat, and agent responses will be sent back to the bot.
Features
- Seamless integration between Botpress and LiveChat
- Real-time message synchronization
- Support for text messages
- Automatic chat session management
- Webhook-based event handling
Configuration
The integration requires the following configuration:
clientId
: Your LiveChat client IDorganizationId
: Your LiveChat organization IDwebhookSecret
: Secret key for webhook verification
LiveChat App Setup for Botpress Integration
This guide walks you through the creation and configuration of a LiveChat app via platform.text.com to enable integration with your Botpress chatbot.
📹 Video Guide: Watch our step-by-step setup guide on Loom
Step-by-Step Instructions
1. Create a New App
- Navigate to https://platform.text.com/console/apps
- Click "Build App"
- Enter your app name
- Ensure Livechat is selected as the product
- Click "Create App"
2. Add the App Authorization Block
- Go to Blocks
- Click "Add Building Block"
- Choose App Authorization → Server-side App
- Copy the Client ID
- In your Botpress LiveChat integration config, paste this Client ID
- Add the following scope:
chats.conversation--all:rw
- Important: Add your Botpress webhook URL to the Redirect URIs field in this block
3. Add Your Organization ID
- Go to https://platform.text.com/console/settings/account
- Copy your Organization ID
- Paste it into your Botpress LiveChat integration config
4. Configure Webhooks
a. Incoming Event Webhook
In the Blocks section, add a Chat Webhooks block
Set the Webhook URL to your Botpress LiveChat integration webhook URL
Generate a secret key and use the same key in your Botpress config
Set the following:
Type:
license
Trigger:
incoming_event
Filter:
author_type = agent
Click Save
b. Chat Deactivated Webhook
Add another Chat Webhooks block
Use the same webhook URL and secret key
Set:
Trigger:
chat_deactivated
Type:
license
Click Save
c. Chat Transferred Webhook
Add one more Chat Webhooks block
Use the same webhook URL and secret key
Set:
Trigger:
chat_transferred
Type:
license
Click Save
5. Finalize App Setup
a. Add an Icon
- Go to the Listing Details section
- Upload a random icon for your app (any image will work)
b. Install the App
- Go to the Private Installation tab
- Click "Install App"
Summary of Required Botpress Config
- Client ID: From App Authorization block
- Organization ID: From Account Settings
- Secret Key: From webhook setup
- Webhook URL: Provided by Botpress
- Scopes:
chats.conversation--all:rw
- Redirect URI: Must include your Botpress webhook URL in the App Auth block
Usage
- Configure the integration with your LiveChat credentials
- Start a chat session using the
startHitl
action - Messages from the bot will appear in LiveChat
- Agent responses in LiveChat will be sent back to the bot
Events
The integration handles the following LiveChat events:
incoming_event
: New messages from agentschat_deactivated
: Chat session endedchat_transferred
: Chat transferred to another agent
Security
- Webhook verification using a secret key
- OAuth2 authentication for API calls
- Secure token management
Support
For support, please contact the Botpress team or refer to the LiveChat API documentation.