New More Than Just Live Chat — Announcing Facebook and Twitter Integration in Comm100 Live Chat >> ×

What information is required in the Agent Console Extension file?

September 19th, 2017 | Monitor & Chat

The Agent Console Extension allows you to extend the capability of the chat console by creating a custom tab for you to perform additional tasks.

To create an additional customer tab, you will need to upload an extension file with all the required files such as images, JavaScript and CSS. Our Agent Console Extension Sample File is hosted on GitHub. You can download, modify and test it in your own account.

We also provide Agent Console APIs which allows your custom extension to perform further interaction with the Agent Console itself, such as getting information of chatting visitors, and information of the logged-in agents, or even send messsages to current chat.

Agent Console Extension Upload Files

The extension File must be compiled in .zip format file with the maximum size of 2MB. This .zip file mainly includes the following content:

  1. manifest.json

    This is the required key file and needs to be in .json format.The .json file describes each file info and their path in .zip package. It provides some configuration settings, such changing the custom tab name. Our system will load the custom tab based on this .json file

    Here is a template for the information needed in the manifest.json file:

    {
      "name": "KB",   
      "index": "/index.html",  
      "icon": "/assets/icon.png",     
      "author": {
        "name": "Allon",
        "email": "allon.lu@comm100.com",
        "url": "https://www.comm100.com"
      },
      "version": "1.0.0",  
      "manifestVersion": "1.0"
    }
    

    Property of the manifest.json file:

    Property Description
    name The Name of the custom tab that will show in Agent Console together with other existing tabs. Value is required and mustn’t be empty.
    index Defines the location of index file. You can also set the index to an external URL such as “index”: “https://kb.mydomain.com/ext”. Value is required and mustn’t be empty.
    icon The image icon of the custom tab. Value is required and mustn’t be empty.
    author Information of the author who created the extension file. Such as the Name, Email, and website information.
    version The version of the extension file. Value is required and mustn’t be empty.
    manifestVersion The version of the manifest.json file. Value is required and needs to be set as “1.0”
  2. The Index File of the Extension

    The index file needs to be in .html format. It defines the file opened through the custom tab. You can include the index file itself in the .zip file. Alternatively, you can also have the index file pointing to an external URL as mentioned in the manifest.json file. The Index file can also use our own Agent Console SDK and public CSS from our sample extension file.

  3. The Image Icon of Tab

    It is the icon file of the custom tab. The file format can be nearly all the formats, including .png, .jpg, .gif, and etc. The recommended size is 16px*16px.

  4. Other Files

    Other JavaScript and CSS files that need to be used in your extension file.