Plugins | Widgets

Data Access

Updated on October 22, 2023

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:sessions`
`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` (see the conversation meta information)	`website:conversation:sessions`
`participants`	`website:conversation:participants`
`last_message`	`website:conversation:messages`
`topic`	`website:conversation:sessions`
`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`

The user email can be found in conversation.meta.email.

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`

Helpdesk locales

Only supported by iFrame widget.

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

Property	Required Scope
`locale_id`	`website:helpdesk:locales`
`locale`	`website:helpdesk:locales`
`url`	`website:helpdesk:locales`
`articles`	`website:helpdesk:articles`
`categories`	`website:helpdesk:categories`

Plugin settings

Supported by generic and iFrame widgets.

The following properties are accessible through the plugin_settings object:

Property	Required Scope
`plugin_id`	(no scope required)
`website_id`	(no scope required)
`schema`	(no scope required)
`settings`	(no scope required)