Embedded AI Assistant Installation Guide

This guide is a generic installation guide for setting up the required chat application configurations in Moveworks Setup and preparing the code snippet to host Moveworks Embedded AI Assistant on a web page.

Please review our Embedded AI Assistant Overview page for more details on behavior and requirements.

Create a Chat Application in Moveworks Setup

Within Moveworks Setup, navigate to Manage Chatbots and click Create to generate a new chat application configuration for the Embedded AI assistant.
Configure the following fields:
1. Channel: movewebchat
2. Select Connector: movewebchat
3. Bot ID: enter 1234 this ID value will be replaced with a generated ID upon save
4. Bot Name (Moveworks Identifier): use your Moveworks organization name “-webchat”
  1. Example: acme-webchat
5. Bot Friendly Name: User facing name of the Assistant
6. Channel Configurations: Set to Movewebchat Vars
Leave the remaining fields blank and click Submit
Set the Config Title to the Bot Name from step iv (example “acme-webchat”)
Once saved, click edit on the chat application you just created to retrieve the generated Bot ID. Note the ID down as it will be used later in the embed script.

Customize the Embedded AI Assistant

Within Moveworks Setup, navigate to Web Chatbot > Design Settings
Customize Theme settings and add a publicly accessible avatar image URL. If your organization does not have an image hosting service, please contact Moveworks Support to utilize Moveworks image services.

Create an SSO Application to authenticate the Embedded AI Assistant

When embedding the Assistant on ServiceNow, we recommend using the Moveworks for Employee Center plugin, which utilizes the built-in authentication for ServiceNow. Skip this section and go straight to the instructions to embed the AI Assistant on ServiceNow.

Follow one of our available guides to create an SSO application to authenticate the Embedded AI Assistant

Azure OIDC SSO Setup Guide

Okta OIDC SSO Setup Guide

Okta SAML SSO Setup Guide

Onelogin OIDC SSO Setup Guide

General SAML SSO Setup Guide

Embed the AI Assistant on a webpage

Follow the system specific embed guides for the following systems to embed the AI Assistant as there are additional steps required to add the script to the page:

For a standard webpage that allows for embedding HTML & Javascript use, use the script below to embed the AI Assistant on your page.

If your installation does not require any style overrides then use the following script, replacing the <bot_id> text with the ID noted down from step 5 of Create a Chat Application in Moveworks Setup above.

Commercial

<script src="https://webchat-kprod.moveworks.io/script/<bot_id>" />

Gov

The shortened script is not available for Gov region. Use the script below.

<script src="https://webchat.prod.am-euc1.moveworks.io/script/<bot_id>" />

Canada

<script src="https://webchat.prod.am-cac1.moveworks.io/script/<bot_id>" />

Australia

<script src="https://webchat.prod.am-apse2.moveworks.io/script/<bot_id>" />

Use the following script to include style overrides:

Commercial

<div id="webchat">
    <script>
        var script = document.createElement('script');
        script.type = "text/javascript";
        script.onload = function () {
            window.mwwebchat.openMWWebChat(
                '', <!--Leave this blank; this is for token-based deploys. -->
                '<bot_id>',
                {
                    serverUrl: 'https://webchat-kprod.moveworks.io/login/<bot_id>',
                    styles: '<optional, see below>'
                },
            );
        };
        script.src = 'https://webchat-kprod.moveworks.io/movewebchat-client-script.js';
        document.getElementById('webchat').appendChild(script);
    </script>
</div>

Gov

<div id="webchat">
    <script>
        var script = document.createElement('script');
        script.type = "text/javascript";
        script.onload = function () {
            window.mwwebchat.openMWWebChat(
                '', <!--Leave this blank; this is for token-based deploys. -->
                '<bot_id>',
                {
                    serverUrl: 'https://<org_name>-chat.moveworksgov.com/login/<bot_id>',
                    styles: '<optional, see below>'
                },
            );
        };
        script.src = 'https://<org_name>-chat.moveworksgov.com/movewebchat-client-script.js';
        document.getElementById('webchat').appendChild(script);
    </script>
</div>

<div id="webchat">
    <script>
        var script = document.createElement('script');
        script.type = "text/javascript";
        script.onload = function () {
            window.mwwebchat.openMWWebChat(
                '', <!--Leave this blank; this is for token-based deploys. -->
                '<bot_id>',
                {
                    serverUrl: 'https://webchat.prod.am-euc1.moveworks.io/login/<bot_id>',
                    styles: '<optional, see below>'
                },
            );
        };
        script.src = 'https://webchat.prod.am-euc1.moveworks.io/movewebchat-client-script.js';
        document.getElementById('webchat').appendChild(script);
    </script>
</div>

Canada

<div id="webchat">
    <script>
        var script = document.createElement('script');
        script.type = "text/javascript";
        script.onload = function () {
            window.mwwebchat.openMWWebChat(
                '', <!--Leave this blank; this is for token-based deploys. -->
                '<bot_id>',
                {
                    serverUrl: 'https://webchat.prod.am-cac1.moveworks.io/login/<bot_id>',
                    styles: '<optional, see below>'
                },
            );
        };
        script.src = 'https://webchat.prod.am-cac1.moveworks.io/movewebchat-client-script.js';
        document.getElementById('webchat').appendChild(script);
    </script>
</div>

Australia

<div id="webchat">
    <script>
        var script = document.createElement('script');
        script.type = "text/javascript";
        script.onload = function () {
            window.mwwebchat.openMWWebChat(
                '', <!--Leave this blank; this is for token-based deploys. -->
                '<bot_id>',
                {
                    serverUrl: 'https://webchat.prod.am-apse2.moveworks.io/script/<bot_id>',
                    styles: '<optional, see below>'
                },
            );
        };
        script.src = 'https://webchat.prod.am-apse2.moveworks.io/movewebchat-client-script.js';
        document.getElementById('webchat').appendChild(script);
    </script>
</div>

You can add these optional parameters along with the serverURL. See below.
- styles controls the position of the avatar

Commercial

								{
                    serverUrl: 'https://webchat-kprod.moveworks.io/login/<bot_id>',
                    styles: { 
							        bottom: '0px',
							        right: '10px',
							        zIndex: 999,
							    },
                },

								{
                    serverUrl: 'https://<org_name>-chat.moveworksgov.com/login/<bot_id>',
                    styles: { 
							        bottom: '0px',
							        right: '10px',
							        zIndex: 999,
							    },
                },

								{
                    serverUrl: 'https://webchat.prod.am-euc1.moveworks.io/login/<bot_id>',
                    styles: { 
							        bottom: '0px',
							        right: '10px',
							        zIndex: 999,
							    },
                },

Canada

								{
                    serverUrl: 'https://webchat.prod.am-cac1.moveworks.io/login/<bot_id>',
                    styles: { 
							        bottom: '0px',
							        right: '10px',
							        zIndex: 999,
							    },
                },

Australia

								{
                    serverUrl: 'https://webchat.prod.am-apse2.moveworks.io/login/<bot_id>',
                    styles: { 
							        bottom: '0px',
							        right: '10px',
							        zIndex: 999,
							    },
                },