purecloud-client-app-sdk
Advanced tools
Readme
A JavaScript library to deeply integrate a 3rd-party applications within Genesys Cloud. This library handles App and UI-level integration concerns such as navigation, alerting, attention, and lifecycle management. For data access, plese use the Genesys Cloud Platform API Javascript Client.
$ npm install purecloud-client-app-sdk
# -or-
$ yarn add purecloud-client-app-sdk
https://sdk-cdn.mypurecloud.com/client-apps/<taggedversion>/purecloud-client-app-sdk.js
https://sdk-cdn.mypurecloud.com/client-apps/<taggedversion>/purecloud-client-app-sdk-<hash>.min.js
In the simpliest form, a Genesys Cloud App is simply a web page that enhances or extends Genesys Cloud functionality. If you have a deployed web site, you could have a Genesys Cloud app!
Use this API to improve the integration of your app with Genesys Cloud. Navigate, notify, and request attention all through a simple JS API.
Use the Genesys Cloud Platform API Javascript Client to access Genesys Cloud data within your app.
After you've built your app, you will need to configure it to appear in your org.
Genesys Cloud Apps can be added via the Genesys Cloud UI under Admin > Integrations > Web
Alternatively, you can use the REST API or Genesys Cloud SDKs to programmatically create a Genesys Cloud App.
POST /api/v2/integrations
{
"integrationType": {
"id": "embedded-client-app"
}
}
The create call will return an {integrationInstanceId}.
Use the {integrationInstanceId} to configure the app.
You must provide the current version of the config as a version property to the PUT. For the first update, this will be 1
(Not all of the following properties/values are required.)
PUT /api/v2/integrations/{integrationInstanceId}/config/current
{
"name": "Custom Application Name",
"notes": "Optional Application Notes",
"credentials": {},
"version": {currAppConfigVersion},
"properties" : {
"url" : "https://mypurecloud.github.io/client-app-sdk/help.html",
"sandbox" : "allow-forms,allow-modals,allow-popups,allow-presentation,allow-same-origin,allow-scripts,allow-downloads",
"displayType": "standalone", // standalone, widget
"featureCategory": "", // directory, contactCenterInsights
/*
* PC Group IDs identifying users who will be able to see this embedded-client-app.
*
* Note: This only affects display within the Genesys Cloud UI. App developers should not rely on
* this mechanism alone for user authorization. Check server-side before granting access to a
* user.
*/
"groups": []
},
"advanced": {
"i10n": {
"es": {
"name": "Genesys Cloud ejemplo de la Ayuda"
},
"fr": {
"name": "Genesys Cloud Aide Exemple"
}
},
"lifecycle": {
"ephemeral": false,
"hooks": {
"bootstrap": false,
"focus": false,
"blur": false,
"stop": false
}
},
"icon": {
"vector": "https://mypurecloud.github.io/client-app-sdk/img/066-lifebuoy.svg",
"24x24": "https://mypurecloud.github.io/client-app-sdk/img/066-lifebuoy-24x24.png",
"36x36": "https://mypurecloud.github.io/client-app-sdk/img/066-lifebuoy-36x36.png",
"48x48": "https://mypurecloud.github.io/client-app-sdk/img/066-lifebuoy-48x48.png",
"72x72": "https://mypurecloud.github.io/client-app-sdk/img/066-lifebuoy-72x72.png"
},
}
}
PATCH /api/v2/integrations/{integrationInstanceId}
{
"intendedState": "ENABLED"
}
The Genesys Cloud Client Apps SDK is MIT Licensed
The Genesys Cloud Client Apps SDK comprises other software and packages
MIT License
Copyright (c) Sindre Sorhus sindresorhus@gmail.com (sindresorhus.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
IcoMoon icons used under CC By 4.0
https://github.com/Keyamoon/IcoMoon-Free
Example Icons made by FreePik from www.flaticon.com is licensed by CC 3.0 BY
Example Icons made by Cursor Creative from www.flaticon.com is licensed by CC 3.0 BY
Example Icons sourced from svgrepo are licensed by CC 4.0 BY
FAQs
Javascript API for integrating 3rd-party apps with Genesys Cloud
The npm package purecloud-client-app-sdk receives a total of 876 weekly downloads. As such, purecloud-client-app-sdk popularity was classified as not popular.
We found that purecloud-client-app-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.