๐Ÿค– Chatbot
โš™๏ธ Customization
Chatbot SDK
Web/SDK

Introduction

This documentation provides details on how to use the Chatbot Web SDK. The Chatbot Web SDK allows you to integrate a chatbot into your website.

To integrate the Chatbot Web SDK into your website, you need to inject the following script:

html

Replace YOUR_WIDGET_ID with your actual widget ID. You can find your widget ID in the Chatbot Dashboard (opens in a new tab).

๐Ÿ“

Make sure to load this script before accessing the $yourgptChatbot variable for calling functions. The $yourgptChatbot variable is only available after the script is loaded.

$yourgptChatbot

After the Chatbot Web SDK script is loaded, the $yourgptChatbot variable becomes available. This variable provides methods to interact with the chatbot.

Execution Commands

These are the commands that can be executed using the $yourgptChatbot.execute() function.

CommandDescription
widget:openOpens the chatbot.
widget:closeCloses the chatbot.
message:sendSends a message to the chatbot.
message:send payload
PropertyDescriptionTypeDefault
textThe message text.string
sendIndicates whether the message should be sent to the chatbot or not.booleanfalse

Opening the chatbot

js

Sending a message to the chatbot

js

Here the text is the message that you want to send to the chatbot. The send parameter is a boolean value that indicates whether the message should be sent to the chatbot or not. If the send parameter is set to false, the message will be displayed in the chatbot but will not be sent to the chatbot.

๐Ÿ“

This command will open the chatbot if it is not already open.

Closing the chatbot

js

Event Listeners

The Chatbot Web SDK provides event listeners that you can use to listen to events that occur in the chatbot. To add an event listener, you need to call the $yourgptChatbot.on(event,callback) function.

Event NameDescriptionArguments
initTriggered when the chatbot is initialized.
widget:popupTriggered when the chatbot popup opens or closes. It provides a boolean in the callback indicating the state (true for open, false for closed).state:boolean

Example: Listen to the init event

js

Removing an event listener

To remove an event listener, you need to call the $yourgptChatbot.off(event,callback) function.

Set Command

The Chatbot Web SDK provides a set command that you can use to set visitor, session and widget data. To set data, you need to call the $yourgptChatbot.set(type,data) function.

TypeDescriptionPayload
visitor:dataSets the visitor data.object
session:dataSets the session data.object

Example: Set visitor data

js

Example: Set session data

js

Set Contact Data

TypeDescriptionPayload
contact:dataSets the contact data.
object
Check supported fields ๐Ÿ‘‡

Supported Contact payload fields for update

FieldDescriptionTypeRequired
emailA valid email address.stringEither email or phone is required
phoneA valid phone number eg +1234567890.stringEither phone or email is required
nameName of the contact.stringNo
ext_user_idA unique identifier for the contact.stringNo
๐Ÿ“

For contact update, either email or phone must be provided.

Example: Set contact data

js

Configuring Data for Iframe Embeds

If you are using the Chatbot Web SDK with an iframe embed, you can set the visitor, session, and contact data by passing the data in the query parameters of the iframe URL.

Visitor Data

To set visitor data, append the VISITOR_DATA.keyName=value query parameter to your iframe URL.

html

Session Data

To set session data, append the SESSION_DATA.keyName=value query parameter to your iframe URL.

html

Contact Data

To set contact data, append the CONTACT.keyName=value query parameter to your iframe URL.

html
๐Ÿ“

Here <widgetUrl> is the URL of your chatbot widget.

๐Ÿ“

You can pass multiple query parameters by separating them with an &.

html
curl