How to Extend Visitor Badge
  • 16 Sep 2022
  • 1 Minute to read
  • Dark

How to Extend Visitor Badge

  • Dark

Article summary


This article introduces how to develop an app to extend visitor badge in the Agent Console. You can learn how to add an icon beside the visitor avatar by implementing the click event "" API.

You can also use Server API(Restful) and App API(JavaScript) to implement complex logic based on your requirements.
By following the step-by-step instructions in the example, you can see a new icon beside the visitor avatar, as follows:



Read Developing An App for setting up a testing environment.


  1. Configuring the manifest file
  2. Modifying the index.html
  3. Testing App

Configuring the manifest file

Configure manifest as following and make sure you input visitorBadge as widget's type.

  "manifestVersion": "2.0",
  "agentConsole": {
    "widgets": {
      "visitorBadge": {
        "id": "custom-icon",
        "url": "./index.html",
        "tooltip": "Custom Icon",
        "icon": "./icon.png"

Modifying the index.html

Copy the following code to index.html

<!DOCTYPE html>
    <meta charset="utf-8" />
    <title>Hello App</title>
    <script type="text/javascript" src="./js/APPClient.js"></script>
    <link rel="stylesheet" type="text/css" href="./css/style.css" />
    <script type="text/javascript">
      var client = APPClient.init();
      client.on("", function () {
        // do stuff

Testing App

Follow this guide, log in to Agent Console, simulate a chat, then switch to the chat tab; you can find the icon beside the visitor avatar.


Was this article helpful?