Overview

The Quidget Web Chat provides a simple JavaScript API that allows you to control the chat widget programmatically from your website.

Prerequisites

Before using the API, ensure that the Quidget Web Chat is fully installed and initialized on your page. The chat widget must be properly loaded and ready to function.

Available Methods

Method	Description
showChat()	Opens the chat widget, making it visible to users
hideChat()	Closes the chat widget, hiding it from users
startChat()	Opens the chat and skips the home screen if it exists

---

window.quidget.api.showChat()

Description: Opens the chat widget, making it visible to users. This method is equivalent to clicking the chat button.

Usage: Call this method when you want to display the chat interface to your users.

---

window.quidget.api.hideChat()

Description: Closes the chat widget, hiding it from users. This method is equivalent to clicking the close button on the chat interface.

Usage: Call this method when you want to hide the chat interface from your users.

---

window.quidget.api.startChat()

Description: A comprehensive method that not only opens the chat but also skips the home screen if it exists. This is the most common method for initiating a chat conversation.

Usage: Use this method when you want to directly start a chat conversation, bypassing any welcome or home screen content.

---

Implementation Examples

Add a button to your page that opens the chat when clicked:

<button onclick="window.quidget.api.startChat()">OPEN CHAT</button>

Custom Event Integration

Trigger the chat based on user interactions:

// Open chat when user scrolls page
window.addEventListener('scroll', function() {
    if (your_condition) {
        window.quidget.api.startChat();
    }
});

---

Error Handling

If the chat widget is not properly initialized, API calls may not work as expected. Always ensure the chat is fully loaded before attempting to use these methods.

// Check if chat is available before using
if (window?.quidget?.api) {
    window.quidget.api.startChat();
} else {
    console.warn('Quidget Chat is not yet loaded');
}

Customizing appearance of the Web Chat

The Appearance tab allows you to tailor the look of your Web Chat, including its view mode, color scheme, widget position, and logo.

---

Chat view

You can choose between the “Permanent” and “Widget” view of the Web Chat. The “Permanent” view displays the Web Chat in a window that remains active on the page where the Chat script is inserted in the </body> section. The “Widget” view will display the Web Chat in the form of a bubble that expands when clicked (the Web Chat script must also be inserted into the </body> of the page).

---

Action color

You can change the color used in notification bubbles, buttons, and links. Enter the desired color in the #HEX field, or choose it from the palette by clicking on the color picker.

---

Header color

You can change the color used in the header and on the main screen. You can leave it as “Default” if you prefer the default header style, or choose “Custom” and enter the desired color in the #HEX field or select it from the palette by clicking on the color picker.

---

Widget position

You can choose the location of the widget on your website in the “Widget” view of Web Chat. Select either “Left” or “Right” positioning of the Web Chat on your page.

---

Custom widget logo

Add a custom logo for your embedded Web Chat. Upload an image from your media library or drag and drop to set it as the logo for the Web Chat widget.

Customizing the Home Screen

The Home Screen tab allows you to personalize key aspects of your chatbot’s initial interface, creating a welcoming experience for users.

---

Background

Customize the background to match your brand identity. Change the color by entering the desired color in the #HEX field, or select it from the palette by clicking on the color picker. You can also choose Gradient and customize the transition between colors as you like, or upload a picture if desired.

---

Greeting

Enter your keyword phrase, which will be displayed in a large size, so your customers never miss it.

---

Introduction

Write all the necessary details about your chatbot to describe its role and functions.

---

Start button text

Customize the name of the “Start chat” button. Be careful as it retains its call-to-start function.

Configuring security settings

The Security tab offers features to enhance the safety of your Web Chat.

---

Trusted domains

Restrict the use of Web Chat to specific domains by selecting only the ones you need. This ensures your safety and the safety of your customers.

---

Country filter

In case you need to restrict the use of Web Chat to certain countries, you can choose one of two options: Allowed countries and Forbidden countries, which indicate the allowed or prohibited countries for Web Chat to be displayed.

---

Allowed / Forbidden countries

Depending on the option you choose, all selected countries will either be listed as “Allowed” (indicating that Web Chat will only work in those countries) or “Forbidden” (indicating that Web Chat will not be shown in those countries).

Publishing the Web Chat

The Publish tab provides quick access to the code needed to install the Web Chat widget on your website.

---

Code

Copy and paste this code into the <body> of your website’s DOM tree so that Web Chat will start on the page where the script is placed.