Default properties

Introduction

This document is a reference listing all the existing default properties. You can make use of them in your applications, by extracting important info about customer behavior, chats, threads, and events.

By default, they're created for each new LiveChat license. With the right access, you can change the values of the property instances. You cannot add or remove properties in a namespace. Neither can you change the access of a given property or rename a namespace.

If you need to brush up on properties, read more.

Reference

Namespace	Properties
lc2	`file_safety_confirmation` `form_type` `greeting_id` `greeting_unique_id` `welcome_author_id` `welcome_message` `welcome_text`
rating	`comment` `score`
routing	`continuous` `email_follow_up` `idle` `last_transfer_timestamp` `pinned` `was_pinned` `ignore_agents_routing` `ignore_bots` `unassigned` `unreplied` `referrer` `start_url` `transcript_email` `offline_message`
source	`client_id` `customer_client_id`
url_details	`description` `image_height` `image_width` `image_url` `title` `url`
status	`delivered`
test	`bool_property` `int_property` `string_property` `tokenized_string_property`
translation	`source_lang_code` `target_lang_code` `target_message`

lc2

file_safety_confirmation

Describes if a user confirmed the safety of the received file.


Access	`rw` for Agents in events
Data type	`bool`

form_type

Specifies the form type (prechat, postchat or ticket). More on forms...


Access	for Agents, `r` in events for Customers, `rw` in events
Data type	`string`
Values	`prechat` `postchat`

greeting_id

Specifies the ID of the greeting configured within a license. More on greetings...


Access	for Agents, `r` in threads and events for Customers, `rw` in threads and `r` in events
Data type	`int`

greeting_unique_id

Specifies the ID of a particular greeting instance sent to the Customer. More on greetings...


Access	for Agents, `r` in threads and events for Customers, `rw` in threads and `r` in events
Data type	`string`

welcome_author_id

Specifies the ID of the welcome message author.


Access	`rw` for Customers in chats and threads
Data type	`string`

welcome_message

Specifies that a given event is a welcome message.


Access	`r` for Agents and Customers in events
Data type	`bool`

welcome_text

Contains the welcome message text. Appears only if "welcome_message": true.


Access	`rw` for Customers in chats and threads
Data type	`string`

Properties in the lc2 namespace

Copied!

{
  "properties": {
      "lc2": {
          "file_safety_confirmation": true,
          "form_type": "prechat",
          "greeting_id": 2,
          "greeting_unique_id": "Q10X0W041P",
          "welcome_author_id": "bbb67d600796e9f277e360e842418833",
          "welcome_message": true,
          "welcome_text": "Welcome! How can I help you today?"
      }
  }
}

rating

The properties describing chat rating.

comment

Contains the text message rating left by the Customer.


Access	for Agents, `r` in chats, threads, and events for Customers, `rw` in chats, threads, and events
Data type	`string`

score

Describes chat rating: 0 - thumbs down, 1 - thumbs up.


Access	`r` for Agents in chats, threads, and events `rw` for Customers in chats, threads, and events
Data type	`int`
Values	`0` `1`

Properties in the rating namespace

Copied!

{
  "properties": {
      "rating": {
          "comment": "Action completed",
          "score": 0
      }
  }
}

routing

continuous

Specifies if a chat is continuous. It can be set when starting a chat with the continuous parameter or via an integration that supports continuous chats. More on the LiveChat Messaging Mode feature...


Access	`r` for Agents and Customers in chats and threads
Data type	`bool`

email_follow_up

Specifies if there should be an email follow-up of the message left by the Customer. For example, when a Customer left a message because they were no online Agents. The email will be sent if the Messaging Mode is enabled for a license.


Access	for Agents, `r` in chats for Customers, `rw` in chats
Data type	`bool`

idle

Specifies if a chat is idle or active.


Access	`r` for Agents in threads
Data type	`bool`

last_transfer_timestamp

Specifies the time and date of the most recent transfer of a chat.


Access	`r` for Agents in threads
Data type	`int`

offline_message

Specifies if a thread was initially created as an offline message.


Access	for Agents, `r` in threads for Customers, `rw` in threads
Data type	`bool`

pinned

Indicates the chat status.

true:

for each active, unassigned chat;

false:

when a chat is closed by an Agent;
when the chat that's being closed by a Customer is in a state diffrent than unassigned;


Access	`r` for Agents in threads and `rw` in chats
Data type	`bool`

was_pinned

Specifies if the chat was previously pinned.


Access	`r` for Agents in chats
Data type	`bool`

ignore_agents_routing

Specifies if automatic routing should be disabled for a given chat.


Access	`rw` for Agents and Customers in chats
Data type	`bool`

ignore_bots

Specifies if the chat should not be routed to Bots during automatic routing.


Access	`w` for Customers in threads
Data type	`bool`

unassigned

Specifies if there is no Agent or Bot assigned to the chat.


Access	`r` for Agents in threads and chats
Data type	`bool`

unreplied

Specifies if no Agent or Bot responded to a given chat.


Access	`r` for Agents in threads
Data type	`bool`

referrer

Contains the info about the web address visited by a Customer prior to starting a chat.


Access	`r` for Agents in threads
Data type	`string`

start_url

Specifies on what page a Customer started a chat.


Access	`r` for Agents and Customers in threads
Data type	`string`

transcript_email

Specifies if a Customer requested a chat transcript.


Access	for Agents, `r` in threads for Customers, `rw` in threads
Data type	`string`

Properties in the routing namespace

Copied!

{
  "properties": {
      "routing": {
          "continuous": true,
          "email_follow_up": false,
          "idle": false,
          "last_transfer_timestamp": 83765782567,
          "pinned": false,
          "was_pinned": true,
          "ignore_agents_routing": true,
          "ignore_bots": false,
          "unassigned": false,
          "unreplied": false,
          "referrer": "https://livechatinc.com/features",
          "start_url": "https://livechatinc.com",
          "transcript_email": "t.anderson@example.com",
          "offline_message": true
      }
  }
}

source

client_id

Specifies the client_id of the application an Agent is chatting from. The client_id and customer_client_id properties might have different values when it's the Agent who started the chat.


Access	`r` for Agents and Customers in chats, threads, and events
Data type	`string`

customer_client_id

Specifies the client_id of the application the Customer is using to chat. The client_id and customer_client_id properties have the same values when the chat was started by the Customer.


Access	`r` for Agents and Customers in chats and threads
Data type	`string`

Properties in the source namespace

Copied!

{
  "properties": {
      "source": {
          "client_id": "0805e283233042b37f460ed8fbf22160",
          "customer_client_id": "0805e283233042b37f460ed8fbf22160"
      }
  }
}

url_details

These properties are used to store URL info in events.

description


Access	`rw` for Agents and Customers in events
Data type	`string`

image_height


Access	`rw` for Agents and Customers in events
Data type	`int`

image_width


Access	`rw` for Agents and Customers in events
Data type	`int`

image_url


Access	`rw` for Agents and Customers in events
Data type	`string`

title


Access	`rw` for Agents and Customers in events
Data type	`string`

url


Access	`rw` for Agents and Customers in events
Data type	`string`

Properties in the url_details namespace

Copied!

{
  "properties": {
      "url_details": {
          "description": "The flow between services",
          "image_height": 480,
          "image_width": 640,
          "image_url": "https://example.com/image25.png",
          "title": "The flow",
          "url": "https://example-url.com/",
      }
  }
}

status

delivered

This property is used to mark events transported from LiveChat to an integration and vice versa.


Access	`rw` for Agents and Customers in events
Data type	`bool`

Properties in the status namespace

Copied!

{
  "properties": {
      "status": {
          "delivered": true
  }
}

test

Use these properties to test things out and learn how properties work. More on test properties...

bool_property


Access	`rw` for all roles in all locations
Data type	`bool`

int_property


Access	`rw` for all roles in all locations
Data type	`int`

string_property


Access	`rw` for all roles in all locations
Data type	`string`

tokenized_string_property


Access	`rw` for all roles in all locations
Data type	`tokenized string`

Properties in the test namespace

Copied!

{
  "properties": {
      "test": {
          "bool_property": true,
          "int_property": 1234,
          "string_property": "Lorem ipsum dolor olet",
          "tokenized_string_property": "Lorem ipsum dolor olet"
    }
  }

translation

These properties are used for storing translated text in message events.

source_lang_code

Specifies the source language code.


Access	for Agents, `rw` in events for Customers, `r` in events
Data type	`string`

target_lang_code

Specifies the target language code.


Access	for Agents, `rw` in events for Customers, `r` in events
Data type	`string`

target_message

Contains message text in the target language.


Access	for Agents, `rw` in events for Customers, `r` in events
Data type	`tokenized string`

Properties in the translation namespace

Copied!

{
  "properties": {
      "translation": {
        "source_lang_code": "en",
        "target_lang_code": "pl",
        "target_message": "Witaj Świecie!"
    }
  }

Contact us

Your questions and feedback are welcome! Send us an email at developers@livechat.com.

Default properties.css-n33kgz{margin-top:8px;}.css-n33kgz > label{margin:6px 10px 5px 0;}

Default properties