How to Extend Top Bar
  • 17 Jun 2022
  • 1 Minute to read
  • Dark

How to Extend Top Bar

  • Dark

Article Summary


This article introduces how to develop an app to extend top bar in the Agent Console.

We will show you how to add an icon button in the Agent Console in this example. You can also use Server API(Restful) and App API(JavaScript) to implement more complex logic based on your own requirements.

After completing all steps, you can see an icon button in the top bar in the Agent Console, 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 follows.

  "manifestVersion": "2.0",
  "agentConsole": {
    "widgets": {
      "topBar": {
        "id": "custom-button",
        "url": "./index.html",
        "label": "Custom Button",
        "icon": "./icon.png"


idstringyesIt as the identity of widget.
urlstringyesThe address of resource, which will be displayed in iframe, can be relative or absolute.
iconstringnoThe address of image resource.
labelstringnoIt is displayed in the button.
tooltipstringnoIt is displayed in the tooltip

Modifying the index.html

Copy the following code to index.html

<!DOCTYPE html>
<html lang="en">
    <meta charset="utf-8" />
    <title>Hello App</title>
    <script type="text/javascript" src="./js/APPClient.js"></script>
    <script type="text/javascript">
      var client = APPClient.init();
      client.on("", function (button) {
        // no stuff

Testing App

Follow this guide, log in to Agent Console, you can find an icon button in top bar:


Was this article helpful?