Deploying an Add-in

Once you have created an add-in, deploying it consists of two steps:

1. Placing the add-in's files into the appropriate directory.
2. Creating or modifying the add-in configuration file addins.json.

Directory location

Add-in files must be placed within a subdirectory of the addins directory within the Interaction Connect directory.

For instance, if Interaction Connect is deployed under wwwroot/client/, the top-level addins directory would be wwwroot/client/addins/ and the add-in would be deployed to wwwroot/client/addins/example-addin/.

addins.json configuration file

The addins.json configuration file must be placed in the config directory within the Interaction Connect directory.

For instance, if Interaction Connect is deployed under wwwroot/client/, the addins.json must be placed in wwwroot/client/config/.

For each add-in you want users to load, there must be one entry in the addins array property for each add-in directory under the top-level addins directory. The baseUrl property is relative to the top-level addins directory.

For example, to deploy an add-in located in a directory named example-addin, you would create the addins.json configuration file using the following format:

{
  "version": 1,
  "addins": [
    { "baseUrl": "example-addin" }
  ]
}

Note: This file is interpreted in the strict JSON format. Common mistakes include using single quotes (') instead of double quotes (") or not quoting the property names. Add-ins will not load if this file is in the incorrect format.