Overview

Data structures

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

WsTicket

Field	Description
`ticket`stringrequired	Single-use ticket, already inside `url`.
`url`string (uri)required	Wss://…/v1/ws?v=1&ticket=…, ready to open.
`expires_in30`required	Seconds the ticket stays valid.

WsTicket exampleJSON

{
  "ticket": "f3T1dWl0LXRpY2tldC1leGFtcGxl",
  "url": "https://hooks.northwind.example/mlivechat",
  "expires_in": 30
}

LCThread

Field	Description
`id`stringrequired
`created_at`stringrequired
`active`booleanrequired	The thread is not closed.
`user_ids`array of stringrequired
`events`array of LCEventrequired
`properties`objectrequired
`access`LCAccessrequired
`previous_thread_id`string
`next_thread_id`string

LCThread exampleJSON

{
  "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
  "created_at": "2026-11-13T09:30:00Z",
  "active": true,
  "user_ids": [
    "749389f6-853a-76d0-85e2-43aaa689a084"
  ],
  "events": [
    {
      "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
      "created_at": "2026-11-13T07:57:41.512000Z",
      "type": "message",
      "text": "Orders ship within 1 business day.",
      "author_id": "19623f8a-8ab9-7d30-8c10-9ad66d67c87c",
      "visibility": "all",
      "system_message_type": "handover_requested",
      "name": "Nadia Rahman",
      "url": "https://hooks.northwind.example/mlivechat",
      "content_type": "application/pdf",
      "size": 1,
      "width": 1200,
      "height": 800,
      "properties": {}
    }
  ],
  "properties": {},
  "access": {
    "group_ids": [
      0
    ]
  },
  "previous_thread_id": "f81acd41-8943-73b8-8a6b-9a2fab9400a6",
  "next_thread_id": "a47a8181-e08c-71b8-8c9d-81ef58af0226"
}

LCEvent

IDs are strings (our UUIDs); created_at is UTC with microseconds.

Field	Description
`id`stringrequired
`created_at`stringrequired
`type`stringrequired	One of `message`, `file`, `system_message`.
`text`string
`author_id`string	The agent's.
`visibility`stringrequired	One of `all`, `agents`.
`system_message_type`string
`name`string
`url`string
`content_type`string
`size`integer
`width`integer
`height`integer
`properties`object	Our quick replies and postback under the `mlivechat` namespace.

LCEvent exampleJSON

{
  "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
  "created_at": "2026-11-13T07:57:41.512000Z",
  "type": "message",
  "text": "Orders ship within 1 business day.",
  "author_id": "19623f8a-8ab9-7d30-8c10-9ad66d67c87c",
  "visibility": "all",
  "system_message_type": "handover_requested",
  "name": "Nadia Rahman",
  "url": "https://hooks.northwind.example/mlivechat",
  "content_type": "application/pdf",
  "size": 1,
  "width": 1200,
  "height": 800,
  "properties": {}
}

LCAccess

Field	Description
`group_ids`array of integerrequired

LCAccess exampleJSON

{
  "group_ids": [
    0
  ]
}

LCUser

Field	Description
`id`stringrequired
`type`stringrequired	Bots are agents. One of `customer`, `agent`.
`name`string
`email`string
`present`booleanrequired
`avatar`string
`visibility`string	Agents only.
`created_at`string	Customers only.
`session_fields`array of object	Customers only.

LCUser exampleJSON

{
  "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
  "type": "customer",
  "name": "Nadia Rahman",
  "email": "nadia@shop.northwind.example",
  "present": true,
  "avatar": "avatar",
  "visibility": "visibility",
  "created_at": "2026-11-13T09:30:00Z",
  "session_fields": [
    {}
  ]
}