Plugins | Widgets
Give Feedback

Data Access

Updated on October 4, 2021

Generic and iFrame widgets both have direct access to Crisp data, eliminating the need for you to make additional requests to our REST API.

For each supported namespace, a sanitized object is generated, containing only the properties your plugin token has access to. If you want to have access to a specific property, you need to make sure your token includes the required read scope. Read more about Token Scopes here.

Need another namespace or property to be supported? Feel free to chat with our support team.

Supported Namespaces

Conversation

Supported by generic and iFrame widgets.

The following properties are accessible through the conversation object:

Property Required Scope
session_id website:conversation:session
website_id (no scope required)
people_id website:people:profiles
contact_data website:people:data
status website:conversation:states
state website:conversation:states
is_verified website:conversation:sessions
is_blocked website:conversation:sessions
availability website:conversation:sessions
active website:conversation:sessions
meta website:conversation:sessions
participants website:conversation:participants
last_message website:conversation:messages
messages website:conversation:messages
mentions website:conversation:messages
unread website:conversation:messages
in_call website:conversation:calls
assigned website:conversation:routing
created_at website:conversation:sessions
updated_at website:conversation:sessions

Operator

Supported by generic and iFrame widgets.

The following properties are accessible through the operator object:

Property Required Scope
user_id website:operators
avatar website:operators
email website:operators
first_name website:operators
last_name website:operators
locale website:operators
phone website:operators

Operators

Only supported by iFrame widget.

The following properties are accessible through each item of the operators array:

Property Required Scope
user_id website:operators
availability website:operators
avatar website:operators
email website:operators
first_name website:operators
last_name website:operators
has_token website:operators
role website:operators
title website:operators