> ## Documentation Index
> Fetch the complete documentation index at: https://cometchat-013b37f0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Add CometChat Chat Builder Widget to Shopify
> Learn how to embed the CometChat Chat Builder widget into your Shopify store using Liquid templates, theme settings, or Online Store 2.0 app blocks.
You can integrate the **CometChat Chat Builder widget** directly into your Shopify store to enable real-time chat. Once installed, it will:
* Load the Chat Builder bundle on page load
* Initialize CometChat with your App ID, Region & Auth Key
* Automatically log in each visitor (using their Shopify `customer.id` or “guest”)
* Launch a docked chat UI on every page
***
## What You’ll Build
A persistent, docked chat widget in your Shopify theme—fully configurable via Theme Settings or a snippet/app block.
***
## Quick Steps to Embed CometChat Widget
Before you start, sign up at the [CometChat Dashboard](https://app.cometchat.com/) and create an app. Copy:
* **App ID**
* **Region**
* **Auth Key**
1. In Shopify Admin, navigate to **Online Store → Themes → Edit code**
2. Open **layout/theme.liquid**
3. Inside the `` tag, add:
```liquid theme={null}
```
Decide where you want the chat widget to appear—commonly in **sections/footer.liquid** or a new **snippets/cometchat-widget.liquid**. Paste:
```liquid lines highlight={5-7, 22} theme={null}
```
To let non-developers manage credentials from the Shopify Theme Editor, add this section in **config/settings\_schema.json** (just before the final `]`):
```jsonc theme={null}
,
{
"name": "CometChat Settings",
"settings": [
{
"type": "text",
"id": "cometchat_app_id",
"label": "CometChat App ID",
"default": "YOUR_APP_ID"
},
{
"type": "text",
"id": "cometchat_app_region",
"label": "CometChat App Region",
"default": "YOUR_REGION"
},
{
"type": "text",
"id": "cometchat_auth_key",
"label": "CometChat Auth Key",
"default": "YOUR_AUTH_KEY"
}
]
}
```
If your theme supports Shopify 2.0 app blocks, you can make a reusable section:
1. **Online Store → Themes → Edit code**
2. Under **Sections**, click **Add a new section** → `cometchat-widget.liquid`
3. Paste the snippet from the previous step into that file.
4. Save, then add it in **Customize theme** under **App embeds** or as a section on any template:
```liquid theme={null}
{% section 'cometchat-widget' %}
```
***
## Advanced JavaScript APIs
Once the widget is loaded, interact with it via the global `CometChatApp` object:
### Chat and Call Methods
```js theme={null}
// Chat with a particular user
CometChatApp.chatWithUser("UID");
// Chat with a particular group
CometChatApp.chatWithGroup("GUID");
// Initiate calls with a particular user
CometChatApp.callUser("UID");
// Initiate calls with a particular group
CometChatApp.callGroup("GUID");
```
### UI Event Listeners
```js theme={null}
// Message received listener
CometChatApp.uiEvent("onMessageReceived", (msg) => {
console.log("New message received:", msg);
});
// Chat opened listener (for docked mode)
CometChatApp.uiEvent("onOpenChat", (args) => {
console.log("Chat opened", args);
});
// Chat closed listener (for docked mode)
CometChatApp.uiEvent("onCloseChat", (args) => {
console.log("Chat closed", args);
});
// Active chat change listener
CometChatApp.uiEvent("onActiveChatChanged", (args) => {
console.log("onActiveChatChanged", args);
});
```
### User and Group Management
```js theme={null}
// Create or update a user on-the-fly
const user = new CometChatApp.CometChat.User("UID");
user.setName("User Name");
user.setAvatar("https://example.com/uid.png");
user.setLink("https://example.com/profile/uid");
CometChatApp.createOrUpdateUser(user).then((createdUser) => {
console.log("User created/updated", createdUser);
});
// Create or update a group on-the-fly
const group = new CometChatApp.CometChat.Group("GUID", "GROUP_NAME", "public");
CometChatApp.createOrUpdateGroup(group).then((createdGroup) => {
console.log("Group created/updated", createdGroup);
});
```
### Authentication Methods
```js theme={null}
// Login with authToken
CometChatApp.login({ authToken: "your-auth-token" }); // More secure
// Login with UID
CometChatApp.login({ uid: "your-uid" }); // Less secure
// User logout
CometChatApp.logout();
// Logout listener
CometChatApp.uiEvent("onLogout", (args) => {
console.log("onLogout", args);
});
```
### Localization
With language localization, our Chat Widget adapts to the language of a specific country or region. Chat Widget allows you to detect the language of your users based on their browser settings and set the language of the widget accordingly.
You can also set the language manually using the `CometChatApp.localize` method.
The CometChat App supports localization for multiple languages, allowing you to provide a tailored experience for users across different regions.
You can find the list of supported languages and their corresponding language codes below:
| Language | Code |
| ------------------------ | ------- |
| English (United States) | `en-US` |
| English (United Kingdom) | `en-GB` |
| Dutch | `nl` |
| French | `fr` |
| German | `de` |
| Hindi | `hi` |
| Italian | `it` |
| Japanese | `ja` |
| Korean | `ko` |
| Portuguese | `pt` |
| Russian | `ru` |
| Spanish | `es` |
| Turkish | `tr` |
| Chinese | `zh` |
| Chinese (Traditional) | `zh-TW` |
| Malay | `ms` |
| Swedish | `sv` |
| Lithuanian | `lt` |
| Hungarian | `hu` |
```javascript theme={null}
CometChatApp.localize(LANGUAGE_CODE);
Eg. CometChatApp.localize('en-US');
```
It takes the following parameters:
| Parameter | Description | Type |
| -------------- | ------------------------------------------------- | -------- |
| LANGUAGE\_CODE | The language code the texts to be translated into | Required |
***
## Troubleshooting
* **Widget not appearing?**
* Verify your `