Default properties

2 minutes reading time

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.

Available properties

NamespaceProperties
lc2file_safety_confirmation form_type greeting_id greeting_unique_id welcome_author_id welcome_message welcome_text
ratingcomment score
routingcontinuous email_follow_up idle last_transfer_timestamp pinned referrer start_url transcript_email
sourceclient_id customer_client_id
url_detailsdescription image_height image_width image_url title url
statusdelivered
testbool_property int_property string_property tokenized_string_property
translationsource_lang_code target_lang_code target_message

lc2

file_safety_confirmation

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

Accessrw for Agents in events
Data typebool

form_type

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

Access
  • for Agents, r in events
  • for Customers, rw in events
Data typestring
Valuesprechat 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 typeint

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 typestring

welcome_author_id

Specifies the ID of the welcome message author.

Accessrw for Customers in chats and threads
Data typestring

welcome_message

Specifies that a given event is a welcome message.

Accessr for Agents and Customers in events
Data typebool

welcome_text

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

Accessrw for Customers in chats and threads
Data typestring
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 typestring

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 typeint
Values0 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...

Accessr for Agents and Customers in chats and threads
Data typebool

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 typebool

idle

Specifies if a chat is idle or active.

Accessr for Agents in threads
Data typebool

last_transfer_timestamp

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

Accessr for Agents in threads
Data typeint

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;
Accessr for Agents in threads and rw in chats
Data typebool

referrer

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

Accessr for Agents in threads
Data typestring

start_url

Specifies on what page a Customer started a chat.

Accessr for Agents and Customers in threads
Data typestring

transcript_email

Specifies if a Customer requested a chat transcript.

Access
  • for Agents, r in threads
  • for Customers, rw in threads
Data typestring
Properties in the routing namespace
Copied!
{
  "properties": {
      "routing": {
          "continuous": true,
          "email_follow_up": false,
          "idle": false,
          "last_transfer_timestamp": 83765782567,
          "pinned": false,
          "referrer": "https://livechatinc.com/features",
          "start_url": "https://livechatinc.com",
          "transcript_email": "t.anderson@example.com"
      }
  }
}

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.

Accessr for Agents and Customers in chats, threads, and events
Data typestring

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.

Accessr for Agents and Customers in chats and threads
Data typestring
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

Accessrw for Agents and Customers in events
Data typestring

image_height

Accessrw for Agents and Customers in events
Data typeint

image_width

Accessrw for Agents and Customers in events
Data typeint

image_url

Accessrw for Agents and Customers in events
Data typestring

title

Accessrw for Agents and Customers in events
Data typestring

url

Accessrw for Agents and Customers in events
Data typestring
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.

Accessrw for Agents and Customers in events
Data typebool
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

Accessrw for all roles in all locations
Data typebool

int_property

Accessrw for all roles in all locations
Data typeint

string_property

Accessrw for all roles in all locations
Data typestring

tokenized_string_property

Accessrw for all roles in all locations
Data typetokenized 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 typestring

target_lang_code

Specifies the target language code.

Access
  • for Agents, rw in events
  • for Customers, r in events
Data typestring

target_message

Contains message text in the target language.

Access
  • for Agents, rw in events
  • for Customers, r in events
Data typetokenized 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@livechatinc.com.