Skip to main content
You can integrate the CometChat UI Kit Builder widget directly into your Shopify store to enable real-time chat. Once installed, it will:
  • Load the UI Kit 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

1

Register on CometChat & Gather Your Keys

Before you start, sign up at the CometChat Dashboard and create an app. Copy:
  • App ID
  • Region
  • Auth Key
2

Add the UI Kit Builder Bundle

  1. In Shopify Admin, navigate to Online Store → Themes → Edit code
  2. Open layout/theme.liquid
  3. Inside the <head> tag, add: 
    <script defer src="https://cdn.jsdelivr.net/npm/@cometchat/chat-embed@1.x.x/dist/main.js"></script>
3

Mount & Initialize the Widget

Decide where you want the chat widget to appear—commonly in sections/footer.liquid or a new snippets/cometchat-widget.liquid. Paste:
<div id="cometChatMount"></div>

<script>
  const COMETCHAT_CREDENTIALS = {
    appID:     "<YOUR_APP_ID>",
    appRegion: "<YOUR_APP_REGION>",
    authKey:   "<YOUR_AUTH_KEY>",
  };

  const COMETCHAT_USER_UID = "UID"; // Replace with actual user UID

  const COMETCHAT_LAUNCH_OPTIONS = {
    targetElementID: "cometChatMount",  // Element ID to mount the widget
    isDocked: true,                     // true = floating bubble, false = embedded
    width: "700px",                     // Widget width
    height: "500px",                    // Widget height

    // Optional advanced settings:
    // variantID: "YOUR_VARIANT_ID",    // Variant configuration ID
    // chatType: "user",                // "user" or "group"
    // defaultChatID: "uid_or_guid",    // UID or GUID to open chat by default
    // dockedAlignment: "right",        // For docked mode: "left" or "right"
  };


  window.addEventListener("DOMContentLoaded", () => {
    CometChatApp.init(COMETCHAT_CREDENTIALS)
      .then(() => {
        console.log("[CometChat] Initialized successfully");
        return CometChatApp.login({ uid: COMETCHAT_USER_UID });
      })
      .then(user => {
        console.log("[CometChat] Logged in as:", user);
        return CometChatApp.launch(COMETCHAT_LAUNCH_OPTIONS);
      })
      .then(() => {
        console.log("[CometChat] Chat launched!");
      })
      .catch(error => {
        console.error("[CometChat] Error:", error);
      });
  });
</script>
4

(Optional) Expose Credentials in Theme Settings

To let non-developers manage credentials from the Shopify Theme Editor, add this section in config/settings_schema.json (just before the final ]):
,
{
  "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"
    }
  ]
}
5

(Advanced) Use an Online Store 2.0 App Block

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: 
    {% section 'cometchat-widget' %}

​
Advanced JavaScript APIs

Once the widget is loaded, interact with it via the global CometChatApp object:

​
Chat and Call Methods

// 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");

// Show or hide action messages in group chats
CometChatApp.showGroupActionMessages(true);

// Show or hide unread message count bubble on docked layout
CometChatApp.showDockedUnreadCount(true);

​
UI Event Listeners

// 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

// 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

// 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:
LanguageCode
English (United States)en-US
English (United Kingdom)en-GB
Dutchnl
Frenchfr
Germande
Hindihi
Italianit
Japaneseja
Koreanko
Portuguesept
Russianru
Spanishes
Turkishtr
Chinesezh
Chinese (Traditional)zh-TW
Malayms
Swedishsv
Lithuanianlt
Hungarianhu
  • JavaScript
CometChatApp.localize(LANGUAGE_CODE);

Eg. CometChatApp.localize('en-US');
It takes the following parameters:
ParameterDescriptionType
LANGUAGE_CODEThe language code the texts to be translated intoRequired

​
Troubleshooting

  • Widget not appearing?
    • Verify your <script> URL is correct
    • Confirm your App ID, Region & Auth Key
  • Login errors?
    • Ensure the uid exists under Users in your CometChat Dashboard
  • Script blocked?
    • Use the snippet method rather than inline page HTML

​
Need Help?

Reach out to CometChat Support or visit our docs site for more examples.