widgets: Contains an index.js file and a JavaScript file with the widgets app property.settings: Contains an index.js file and a JavaScript file with the settings app property.i18n: Contains an index.js file and a language locale subfolder (for example, en_us) with the JSON language strings for settings and widgets.Contains an index.js file for the root apps array and three subfolders ( i18n, settings, widgets), each with an index.js file and a file, subfolder, or files for the appropriate app property:.However, unlike KViews, widgets load an iFrame-based widget in Kustomer that users can access on any page of the Kustomer platform and not just in the Insight panel. Widgets are similar to KViews that appear in the Insight panel and use the Cards SDK. Use this app template to create an app that installs a widget in Kustomer. The Kustomer team may also request additional security information to notify app users that their data will be sent to a third party. If your public app uses an outbound webhook, the outbound webhook must be mission critical to the app, and your team will need to create a privacy TOS agreement with Kustomer before the public release of the app. The Kustomer Apps Platform team reviews apps that require outbound webhooks during the submission process for public apps. Contains an index.js file for the root apps array and a outbound-webhooks folder with an index.js file and a JavaScript file with the outbound webhooks app property.Use this app template to create an app that installs an outbound webhook in Kustomer. If the external site includes the Kustomer Cards SDK, the KView can communicate with the Kustomer instance. This advanced KView can load an external URL in an iFrame. Use this app template to create an app that installs a more advanced KView. Contains an index.js file for the root apps array and a kviews subfolder with an index.js file and a JavaScript file with the KViews app property.Use this app template as the most minimalist example of installing an app to Kustomer. In the meantime, we've provided an overview of some of the demo app templates in the starter repo: Once you feel comfortable with these demo app configurations, you can experiment and combine different app properties, such as advanced KViews, Outbound Webhooks, and Workflows, to create powerful, feature-rich app experiences for Kustomer users. While these demo app templates contain different app properties, you can create a single Kustomer app that supports and defines all of these possible app properties. Each app template subfolder contains a folder for each app property and any necessary index.js files required to bundle the app definition through commands. src folder contains app templates for common Kustomer app configurations.
APPSTARTER UPDATE
You will need to update this file with the appropriate environment variables for your Kustomer organization. The npm command in this repo pulls these environment variables to register and update apps. env file, including a Kustomer API base URL and API key as environment variables.
env.example: This file stores an example template for your. The get-app-json and register-new-version commands available to use with this repo will pull available JSON from this file. We can use the index.js file to import and to include new apps in the available apps array. Index.js: The root file we will use to hold all of the available apps. We use index.js files with commands to bundle together these app property files into the complete app JSON definition. src folder contains the root index.js file and subfolders for each app template.Īpp template subfolders: Each app template subfolder contains the different app properties for that app. src: This folder contains the main portion of the app templates repo. We've provided an overview of the app template repo structure below: See Register or update an app with commands. Use the npm run register-new-version command in this repo to register or to update an app for your Kustomer organization. The variables are: API_BASE_URL= API_TOKEN=Ĭonfigure the root index.js file to include your app definition in the apps array, if you create a new app definition.
env.example file and a value for each variable. env file in the root of the local repository, and include the environment variables defined within the provided. Use the demo app templates to create a new app directory to configure your app definition.Ĭreate a. You can then clone the new repository to your local machine. The new repository will start with the same files and folders as the kustomer-apps-starter-configs repo. Select the Use this template option in GitHub to create a new repository. To use the Kustomer App Starter Config templates to create a new app, you'll need to do the following:
0 kommentar(er)
