The Configuration API allows you to manage resources such as agents, auto access, bots, groups, properties, and webhooks. You can use it to build advanced integrations as well as alter the configuration of your resources directly via the API.
Here are some of the most common use cases of the Configuration API:
- Build integrations that connect LiveChat with other services via webhooks. React to events happening in the chat.
- Create automation solutions with the use of bots. Connect LiveChat with various AI solutions.
- Use properties to store information about chats, threads, or events.
The LiveChat Configuration API adopts the following versioning convention:
The latest stable version we encourage developers to use. You can only expect bug fixes; no new new functionalities or breaking changes will be introduced.
developer preview (dev preview)
The unstable version that provides a preview of the upcoming functionalities. It's not open for public use by default. If you want to use it, contact us at firstname.lastname@example.org or ask on the chat, and we'll give you access.
The old version we still support. We highly encourage you to switch to the latest stable version.
|legacy||2.0, 3.1, 3.2|
Currently, Configuration API v2 and v3 cover different resources. However, if you're still using v2, we encourage you to switch to v3 as more and more resources are being migrated to v3.
An agent is a type of user who communicates with customers. You can see the sample agent data structure in the response of Get Agent. The Configuration API allows for multiple agent-related actions, including creating, updating, deleting, and suspending agents.See agent methods
Auto access is a functionality that allows for assigning customers to dedicated groups based on the URL or the customer's geolocation. When a customer who matches some pre-defined auto access rules starts a chat, the chat is automatically routed to the specific group. You can use auto access, for example, to provide multi-language support with each group of agents being responsible for communication in a different language.See auto access methods
Bots are similar to regular agents. The main difference between them is that bots have a greater potental for automation, for example, they can listen for and react to incoming webhooks and pushes.
Bots are created and managed via the Configuration API. Just as regualar agents, bots can call Agent Chat API by the Web or RTM API.
Bots are authorized with the use of the agent token. Using bots requires sending the
X-Author-Id header for the Web API and the
author_id property for the RTM API.
To change a bot's status (
offline), use the Set Routing Status method from the Agent Chat API.
Groups let you organize your work by creating teams with agent and bot members. You can use groups to do configuration based on shared settings (language, working hours, department) and to separate chat routing.See group methods
Properties are key-value storages. Depending on the API version, they can be set within the following locations: a chat, a thread, an event, a group, and a license. Property configuration is owned by a Client Id (integration), not by license (v3.3+). Properties can be public or private.Learn more about propertiesSee property methods
In a nutshell, actions invoked by the use of Messaging APIs or the Configuration API result in events. You can be notified about those events with webhooks. LiveChat provides a number of webhooks, which you can register and manage via the Configuration API. Just like properties, webhooks are registered per Client Id (integration), not per license (v3.3+).
We can distinguish two types of webhooks:
- license webhooks
- bot webhooks
Once license webhooks are set up, you will always receive them. Read our tutorial on how to configure LiveChat license webhooks via the Configuration API.
Bot webhooks are strongly coupled with the bot's status (
not accepting chats,
offline). If the bot is offline, webhooks won't be received.
To manage other product-related resources, such as canned responses, goals, greetings, tags, tickets, visitors, see the Configuration API v2 (the old API reference). We highly encourage you to migrate to the current stable version of the Configuration API.See the old API reference