Overview

Data structures

The objects the Configuration API sends and returns, with their fields and an example of each.

LCAgent

Field	Description
`id`stringrequired
`name`stringrequired
`email`string
`role`stringrequired	One of `owner`, `normal`.
`type`stringrequired	One of `human`, `bot`.
`login_status`stringrequired	One of `accepting chats`, `not accepting chats`.
`routing_status`stringrequired	One of `accepting_chats`, `not_accepting_chats`, `offline`.
`job_title`string
`avatar_path`string
`max_chats_count`integerrequired
`groups`array of objectrequired
`suspended`booleanrequired
`awaiting_approval`booleanrequired

LCAgent exampleJSON

{
  "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
  "name": "Nadia Rahman",
  "email": "nadia@shop.northwind.example",
  "role": "owner",
  "type": "human",
  "login_status": "accepting chats",
  "routing_status": "accepting_chats",
  "job_title": "Customer support",
  "avatar_path": "avatar path",
  "max_chats_count": 3,
  "groups": [
    {
      "id": 1,
      "priority": "first"
    }
  ],
  "suspended": true,
  "awaiting_approval": true
}

LCGroup

Field	Description
`id`integerrequired
`name`stringrequired
`language_code`stringrequired
`agent_priorities`objectrequired	Agent ID → first.
`routing_status`stringrequired	One of `accepting_chats`, `not_accepting_chats`, `offline`.

LCGroup exampleJSON

{
  "id": 1,
  "name": "Nadia Rahman",
  "language_code": "language code",
  "agent_priorities": {},
  "routing_status": "accepting_chats"
}

LCTag

Field	Description
`id`stringrequired
`name`stringrequired
`group_ids`array of integerrequired	Empty means every group.
`author_id`string
`created_at`stringrequired

LCTag exampleJSON

{
  "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
  "name": "Nadia Rahman",
  "group_ids": [
    0
  ],
  "author_id": "19623f8a-8ab9-7d30-8c10-9ad66d67c87c",
  "created_at": "2026-11-13T09:30:00Z"
}

LCCannedResponse

Field	Description
`id`stringrequired
`text`stringrequired
`tags`array of stringrequired	Its shortcuts.
`group_id`integerrequired
`is_private`booleanrequired
`author_id`string
`created_at`stringrequired
`updated_at`stringrequired

LCCannedResponse exampleJSON

{
  "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
  "text": "Orders ship within 1 business day.",
  "tags": [
    "tag"
  ],
  "group_id": 0,
  "is_private": true,
  "author_id": "19623f8a-8ab9-7d30-8c10-9ad66d67c87c",
  "created_at": "2026-11-13T09:30:00Z",
  "updated_at": "2026-11-13T09:30:00Z"
}

WebhookAction

One of incoming_chat, incoming_event, chat_deactivated, chat_transferred, thread_tagged, routing_status_set, customer_visit_started.

LCWebhook

Field	Description
`id`stringrequired
`url`stringrequired
`action`WebhookActionrequired	One of `incoming_chat`, `incoming_event`, `chat_deactivated`, `chat_transferred`, `thread_tagged`, `routing_status_set`, `customer_visit_started`.
`description`string
`type`stringrequired	One of `license`.
`additional_data`array of stringrequired
`filters`objectrequired
`enabled`booleanrequired

LCWebhook exampleJSON

{
  "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
  "url": "https://hooks.northwind.example/mlivechat",
  "action": "incoming_chat",
  "description": "Orders to our helpdesk",
  "type": "license",
  "additional_data": [
    "additional data"
  ],
  "filters": {},
  "enabled": true
}