Deploy + install SDK

Create new builds and deploy or rollback on a journey build in your NLX Dialog Studio workspace

What's the Deployment tab?

Deployment allows you to create builds of your journey and deploy it to production whenever changes are made. You may also access the configurator through a successful deployment to install on your web, mobile, or IoT application.

Bots that access your journey through their attached intents do not need to be re-deployed after an initial bot build and deployment. Only updates to the intent flows themselves require a bot re-deployment.

Build & deploy journey

  • Select Review & build

  • Click Create build

  • After a build successfully completes, select Deploy from the Production column

  • Choose the deployment environment and select/deselect languages to support for the deployment

  • When ready, click Create deployment

For failed builds, expand the Details link in the Build status column for additional information.

Changes made to your journey require a new journey build and deployment to be experienced.

Install SDK

  • Select Details link next to the Deployed status

  • Under Setup instructions, click Open journey configurator

  • API key: If not already entered, provide the API key under the journey's Settings and enter it in the configurator's field

  • Conversation ID: Since this is dynamically generated for each conversation session with a user by Dialog Studio, you may parse the ID from the user's URL path. Sample code: https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/get#examples

  • Install code snippet with applicable step IDs (downloaded previously) to each page of your frontend UI

In order for your journey communication to work properly and not trigger CORS errors, make sure to whitelist the URL domain(s) in the journey's Settings.

Last updated