/
App Zone - Plugins

App Zone - Plugins

Overview

In the App Zone section, you can define the external applications you want to use inside the XCALLY Motion environment.

This page describes the Plugins configuration on the New Client Experience, available from version 3.50.0. We recommend using the New Experience web interface to take full advantage of the latest features.

Types of Integration

  • HTML – Opens a web page or a custom HTML file through a link embedded in an XCALLY Motion module.

  • Script – Installs and runs the application as a local app within XCALLY Motion.

Setup Steps

  1. Define your needs and understand if you need to:

    1. Develop a Plugin → How to create a Plugin

    2. Choose one of the available plugins → Ready-to-install Plugins

  2. Upload and Install the Plugin → Upload and Install a Plugin

  3. Enable users and/or agents to access and use the application → Associate the Plugin to Agents and Users

Check this page: How to create a plugin

 

Ready-to-install Plugins

XCALLY provides a set of ready-to-install plugins that you can enable directly within the platform.

These plugins extend system functionality for social media and messaging integrations, softbots, automation tools, data retention management, live call translation, queue management and more.

Please note that some plugins may require add-on licenses.

Social Media and messaging apps

Feature available upon request
The “X” channel is available only upon request. Activation requires access to external paid APIs and may involve additional costs, as determined by the “X” service provider.

Features and Tools

 

Upload and Install a Plugin

To upload and install a plugin, go under the App Zone → Plugins section and follow the below steps:

  1. Click on the Add button

  2. Drop the .zip file in the dialog window or click on the Choose button. The plugin zip file must be 25 MB maximum.

image-20250416-124141.png

  1. Click on “Finish”. 

  2. The plugin will be shown in the Plugins list. Click on the three dots button next to the plugin and select Install.

image-20250416-123934.png

 

  1. The installation process starts.

  2. At the end of the process the Active mark for the plugin is set  and the application name is inserted in the Plugins Menu section.

Once the plugin has been installed, it can be started/stopped, unistalled, downloaded, removed or modified.

If needed, you can edit the Plugin:

  1. Click on the three dots button next to the plugin under App Zone section and select Edit

  2. Check the Settings:

The values shown in the Settings must be defined in the manifest.json file before uploading the plugin

 

If the plugin is Script type you can edit the below fields:

  • Name: the name of the plugin

  • Active: if the plugin is enabled or not

  • Description: the description of the plugin

  • Icon: icon of the plugin, that will be displayed in the web gui

  • Sidebar: the visibility of the plugin in the sidebar:

    • always: both agents and users can see the plugin

    • admin only: only users can see the plugin

    • agent only: only agents can see the plugin

    • never: the plugin is not shown in any sidebar

  • Admin URL: the admin URL of the plugin

  • Agent URL: the agent URL of the plugin

  • Script path: the path of the script

If the plugin is HTML type you can edit the below fields:

  • Name: the name of the plugin

  • Active: if the plugin is enabled or not

  • Description: the description of the plugin

  • Icon: icon of the plugin, that will be displayed in the web gui

  • Sidebar: the visibility of the plugin in the sidebar:

    • always: both agents and users can see the plugin

    • admin only: only users can see the plugin

    • agent only: only agents can see the plugin

    • never: the plugin is not shown in any sidebar

  • Admin URL: the admin URL of the plugin

  • Agent URL: the agent URL of the plugin

Associate the Plugin to Agents and Users

Edit the Staff members Profile and enable the Plugin in order to let them use it (of course, if the application settings allows it), under User Profile and Agent Profile sections.

For the Users with Admin role, all modules are enabled by default.

 

Plugin automatic restart system

The plugin restart system is an opt-in fix and requires enabling .env variables.
The restart system must allow restarting after a chosen time delay, in order to give XCALLY time to fully boot before plugins start making requests.

The restart system is disabled by default

 

.env variables:

  • XC_PLUGIN_RESTART = If set to false, or not present, plugin will not restart

  • XC_PLUGIN_RESTART_DELAY = If plugin restart is active, and this variable is not set, by default is 300 seconds (5 minutes). On the other hand, if the restart plugin is active and the variable is set, the restart waits for the indicated seconds of delay

Consider that if you don’t enable the variable as true, plugins will not reboot at XCALLY Motion restart 

 

FAQ