LiveChat¶
The LiveChat modules allow you to watch the incoming chat, deactivated chat, users added, removed, tagged, and untagged thread chats, chat users, and thread tags from your LiveChat account.
Getting Started with LiveChat¶
Prerequisites
- A LiveChat account - create an account at accounts.livechat.com/.
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting LiveChat to Ibexa Connect¶
To connect your LiveChat account to Ibexa Connect you need to obtain the Client ID and Client Secret from your LiveChat account and insert it in the Create a connection dialog in the Ibexa Connect module.
1. Log in to your LiveChat account.
2. Go to https://developers.livechat.com/ and log in with your LiveChat credentials*.*
3. Click Go to Apps.
4. Click Create new app.
5. In the App Name field, enter a name for the app and click Continue.
6. In the App, click Manage > Authorization.
7. Copy the Client ID and Client Secret to a safe place.
8. Log in to your Ibexa Connect account, add a module from the LiveChat app into an Ibexa Connect scenario.
9. Click Add next to the Connection field.
10. In the Connection name field, enter a name for the connection.
11. In the Client ID and Client Secret field, enter the details copied in step 7 and click Continue.
The connection has been established.
Chats¶
Ibexa Connect automatically creates a webhook in LiveChat once you add an instant trigger to your scenario.
Watch Incoming Chat¶
Triggers when a chat is coming with a new thread.
| Webhook | Enter a name for the webhook. |
Watch Chat Deactivated¶
Triggers when a chat is deactivated by closing the currently open thread.
| Webhook | Enter a name for the webhook. |
Chat Users¶
Ibexa Connect automatically creates a webhook in LiveChat once you add an instant trigger to your scenario.
Watch User Added to the Chat¶
Triggers when a user (customer or agent) is added to a chat.
| Webhook | Enter a name for the webhook. |
Watch User Removed from a Chat¶
Triggers when a user (customer or agent) is removed from a chat.
| Webhook | Enter a name for the webhook. |
Others¶
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to For the list of available endpoints, refer to the LiveChat API Documentation. |
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
Headers |
Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String |
Enter the request query string. |
Body |
Enter the body content for your API call. |
Example of Use - List Webhooks¶
The following API call returns all the webhooks from your LiveChat account:
URL: /v3.3/configurations/action/list_webhooks
Method: POST
Body: {"owner_client_id": "<client_id>"}
Matches of the search can be found in the module's Output under Bundle > Body. In our example, 12 webhooks were returned:
