Step 4 - Deploy Assistant

Daniel D'Souza
Daniel D'Souza
  • Updated

Now that your assistant is ready to go, let's deploy it to production and add it to a channel.

Deploying to Production

To deploy your assistant to production you need to do the two following steps.

  1. Run a preview of the assistant: This compiles the project
  2. Press 'Publish' on the top right: This pushes the version to production
  3. Create a Version: This allows you to roll back if something breaks

When you press publish it will prompt you to create a version. Previous versions can be viewed in the project settings.

Once the project has been published (there will be a progress bar on the top of the screen). Youare ready to move to the next step.

 

Adding to a Website

If you have created a Web Chat type project, you can easily add your chatbot to any website. To access the snippet - click 'embed widget' or visit the integrations tab on the left side of the screen.

 

Once you're there you simply have to copy this snippet and add it to your website code. You can either add it to the footer file or your website if you want it to appear on every page, or at the bottom before the closing </body> tag on the specific page you want it on.

 

 

Here's a quick video overview of how to test it out. For basic instructions on how to customize the web chat appearance click here. For instructions on how to further customize the web chat, you can visit our developer documents here.

 

Using the API

You can visit our full developer documents here.

Clone the starter pack

Download the API Examples repo found here to access a variety of prebuilt API examples, including Node.js, Python, Rust and HTML.

Authentication

We'll need to access the Project API key for the design we want to connect into our app. To obtain the API Key:

  1. Open the Assistant project you are using
  2. Select on the Integrations tab (shortcut: 3). Found on the left-hand menu.
  3. Copy the Dialog API Key found in the Dialog API section.
Above you can see the Integrations section within an Assistant project

Above you can see the Integrations section within an Assistant project

Launch

Open up the API Examples pack in your favourite code editor.

👍 HTML and JQuery

  1. Replace 'YOUR_API_KEY_HERE' in index.html with your API Key.
  2. Open index.html on any browser to start your chat!

Example:

👍 Node.js

  1. If you do not have node, install Node.js and npm from nodejs.org, or follow an equivalent guide.
  2. In this folder, run npm install.
  3. Replace 'YOUR_API_KEY_HERE' in index.js with your Dialog Manager API Key.
  4. run npm start to start your chat!

Example:

$ npm start 
> What is your name?: tyler
what can I do for you?
...
> Say something: send email
who is the recipient?
...
> Say something: tyler@voiceflow.com
what is the title of your email?
...
> Say something: How was your day?
sending the email for tyler@voiceflow.com called "How was your day?". Is that correct?
...
> Say something: yes
successfully sent the email for tyler@voiceflow.com called "How was your day?"
The end! Start me again with `npm start`

Video Walkthrough

Dialog Manager API Examples

You can find our examples repo on the repository here.

 

Scaling Your Assistant

To learn how to scale your assistant you can visit our guides below

Was this article helpful?

3 out of 5 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.