In this page, you'll learn about access and environment objects is Cliq and their structure.
Table of Contents
Access object in Cliq is of the map data type and contains user ID, chat ID and details of the web client used by the user. The access object carries the following arguments to it
| Attribute | Description |
| user_id | User ID (unique string identifier) |
| user_agent | Details of the web client used by the user. |
| chat_id | Details of the chat where the internal component is executed. |
Below is a sample access object
{
"user_id": "1234567",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.109 Safari/537.36",
"chat_id": "22326656503451932348"
}
Environment object in Cliq is of the map data type and contains details about the data center to which the user belongs. The access object carries the following arguments to it
| Attribute | Description |
base_url | The base web address to which all API endpoints or paths are appended. Incase of networks, the base_url would be in the below format https://cliq.zoho.com/network/{NETWORK_NAME} |
data_center | Details of the data center to which the user belongs. |
tld | A top-level domain (tld) is the final part of a domain name, following the last dot, and represents the highest level of the domain. |
Data centers and their TLDs
Data center | TLD |
AU | .com.au |
CA | cloud.ca |
CN | .com.cn |
EU | .eu |
IN | .in |
JP | .jp |
SA | .sa |
UAE | .ae |
UK | .uk |
US | .com |
{
"base_url":"https://cliq.zoho.com/company/{ORG_ID}",
"data_center":"US",
"tld":".com"
}