Creating your application

An application is a website that can be loaded from an HTTPS URL into an iframe in the agent workspace. It can be built using any frontend framework and hosted anywhere as long as it can be loaded by the user’s browser and supports being embedded. In addition to being accessible by the user, the application must integrate the application SDK to establish secure communication between the application and the workspace allowing the application to receive events and data from the workspace.

Installing the Amazon Connect SDK

The Amazon Connect SDK can be installed from NPM. The SDK is made up of a set of modules that can be installed as separate packages, meaning that you should only pull in the packages that you need.

The app package provides core application features like logging, error handling, secure messaging, and lifecycle events, and must be installed by all applications at a minimum to integrate into the workspace.

Note

Only ECMAScript modules are supported at this time.

Install from NPM

Install the app package from NPM by installing @amazon-connect/app.

% npm install --save @amazon-connect/app
   

Events and Requests

The contact package provides the functionality required to allow the app to subscribe callbacks to agent andcontact events and to request agent and contact data. This is the main module needed to integrate your app into the agent workspace and get exposure to its agent/contact data and make your app responsive throughout the contact-handling lifecycle.

Install from NPM

Install the contact package from NPM by installing @amazon-connect/contact.

% npm install --save @amazon-connect/contact  
   

Theme

The theme package defines and applies the Connect theme when developing with Cloudscape.

Install from NPM

Install the theme package from NPM by installing @amazon-connect/theme.

% npm install -P @amazon-connect/theme