For AI agents: visit https://developers.clustaar.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API Reference

Home Guides API Reference Changelog Discussions

v1.0

Guides API Reference Log In

API Reference

v1.0

Webhooks

Principles
Configuration
Behaviour
Return Data Format
Events
- conversation.step_reached
Security

Object references

Actions
Button actions
Other references
Bot inputs
Conversation Element

API

Authentication
Interlocutors
Statistics
Conversation History

Webchat JS SDK

Initialize the Spellz Webchat
Events from the bot
- Listen to an Event
Events from the website
- Send a custom event
- Send a url event
Call function on error
Webchat state
User text field state
- Deactivate the text field
- Activate the text field
User Attributes
- Push a user attribute
- Check if user attribute is set
Send Reply
Send Bot Reply
Swap bot
Swap user
Integrated webchat
Get interlocutor ID
Conversation
- Get conversation url
- Get conversation history
Synchronize user history
Override display header
Override welcome message
Override webchat colors
Override logo
Disable local history
Disable welcome story

Analytics

Introduction
Using Google Tag Manager
Without Google Tag Manager

Powered by

Set Debug mode for Replies

Enable / Disable the debug (verbose) mode for user replies

window.ClustaarWebchat.setDebug(debug: boolean);

Updated about 1 year ago

Close the webchat

User text field state

Updated about 1 year ago

Close the webchat

User text field state