Integrating Widget Bubble

Embed the Bot as a bubble widget on your business website. Users can click the bubble widget to open a chat window, providing services such as online customer support, pre-sales consultation, and lead generation.

How to Integrate into a Website

Go to Bot-Integration-Widget Bubble and copy the "Integration Code".
Paste the code into the head tag of your website's HTML page.
Publish your website to complete the AI Bot embedding and start the conversation.
If you need to customize the UI and logo, control user message frequency, or display proactive messages to enhance interaction rates, you can proceed with advanced settings.

Customizing the UI

This feature supports custom configuration of the widget bubble's size, position, color, icon, logo, and name. alt text

Widget Nickname: Allows customization of the name.
Widget Description: Allows customization of the description.
Theme Settings: Allows customization of the widget's theme color, bubble icon, and Bot's appearance.
Bubble Customization: Supports customization of the bubble's display position and size according to business needs.
Chat Window Customization: Supports customization of the chat window's width and height according to business needs (to ensure compatibility with small screens, it is not recommended to set values too large).
Custom Logo: Growth plan users can customize the logo or choose not to display the logo. Business plan users can customize the domain address.

Proactive Messages

Proactive messages can be displayed as cards or prompt messages to attract users' attention and guide them into a conversation or lead capture before they click the widget bubble. There are two styles of proactive messages: "Prompt Messages" and "Card Messages".

How to Create Prompt Messages

alt text

Message Content: Supports setting up to 3 pieces of content, which will be dynamically displayed from bottom to top on the page once activated.
Display Rules: Supports setting up to 3 prompt trigger conditions, displaying proactive messages when user environment conditions are met.
- Trigger Conditions: Allows judging based on the user's browser/browser language/time zone/country region/operating system/UTM, etc.
- Expressions: Provides calculation expressions such as =/≠/range/contains/does not contain/has value/no value for different types of values like number/string.
- AND & OR: Allows setting that all conditions must be met or any condition can trigger the proactive message.
- Events: Supports triggering proactive messages immediately or after a delay of N seconds.
Message Display Frequency Control: To prevent frequent proactive messages from disturbing users, supports frequency control management by setting the maximum number of displays per "website/page" per "day/week/month".

How to Create Card Messages

alt text After configuring the card message content, other configuration options are the same as above.

Image Upload: Supports custom image uploads. It is recommended to control the image size to avoid long loading times.
Title/Content: Users can input custom text.

How to Enable Proactive Messages

alt text

In the proactive message list, select the target message and click the enable button.
Visit the website page to view the proactive message.
Click the proactive message to open the chat window.

Security and Frequency Control

Domain Whitelist: Defines the domain range where the "widget bubble integration code" can be embedded. If disabled, it is considered unrestricted.
Credit Consumption Limit: Defines the credit consumption limit for the "widget bubble". If disabled, it is considered unrestricted.
- Up to 3 rules can be set.
- Supports setting the total credit consumption limit for the widget bubble by "daily/weekly/monthly".
User Consumption Limit: Defines the credit consumption limit for each user. If disabled, it is considered unrestricted.
- Up to 3 rules can be set.
- Supports setting the credit consumption limit for each user by "daily/weekly/monthly".
User Rate Limit: Defines the message sending frequency limit for each user. If disabled, it is considered unrestricted.
- Up to 3 rules can be set.
- Supports setting the maximum number of messages sent by each user per time period.
- When the limit is exceeded, the Bot will no longer respond and will automatically reply with preset message content.

Event Callback

Create a GA4 callback event, obtain the Measurement Protocol API Secret and Measurement ID from the GA4 target project, and fill them in.
Create a Webhook callback event, select the required callback event according to the page prompts, and fill in the URL and authentication information.
Enable the callback in the event callback list, and check if the data is normal in the GA4 or Webhook address. Once the data is successfully stored, you can analyze the user data.

Advanced Usage

Setting User Information Interface

1. Set User ID window.ChatBot.setUserId("somebody") // Note: Supports Bot developers to set the user identity ID. If not set, the default user identity ID generated by GPTBots will be used. 2. Set User Email window.ChatBot.setEmail("somebody@mail.com") // Note: Supports Bot developers to set the user email. When the user calls for manual service, they can skip the step of filling in the email. If not set, the user must fill in the email address to call for manual service.

          1. Set User ID
window.ChatBot.setUserId("somebody")
// Note: Supports Bot developers to set the user identity ID. If not set, the default user identity ID generated by GPTBots will be used.

2. Set User Email
window.ChatBot.setEmail("somebody@mail.com")
// Note: Supports Bot developers to set the user email. When the user calls for manual service, they can skip the step of filling in the email. If not set, the user must fill in the email address to call for manual service.

This code block in the floating window

Event Callback Data Format

The events and event attributes of the widget bubble transmitted through Webhook or GA4 use the following data format. Please parse and store them accordingly.

{ "client_id": "", //Preferably obtained using GA4's gtag method. If not available, generated by GPTBots. "user_id": "", //UserId set by the developer, null if not set. "event_name": "Show widget bubble", //Event name "event_params": { "key1": "abc", //Event attribute name: attribute value (string) "key2": 123 //Event attribute name: attribute value (number) } }

          {
  "client_id": "",  //Preferably obtained using GA4's gtag method. If not available, generated by GPTBots.
  "user_id": "",  //UserId set by the developer, null if not set.
  "event_name": "Show widget bubble",     //Event name
  "event_params": {  
      "key1": "abc",  //Event attribute name: attribute value (string)
      "key2": 123     //Event attribute name: attribute value (number)
    }
}