OpenDialog Docs
opendialog.aiStart BuildingTalk to an expert
  • GETTING STARTED
    • Introduction
    • Getting ready
    • Billing and plans
    • Quick Start AI Agents
      • Quick Start AI Agent
      • The "Start from Scratch" AI Agent
        • Chat Management Conversation
        • Welcome Conversation
        • Topic Conversation
        • Global No Match Conversation
        • Supporting LLM Actions
        • Semantic Classifier: Query Classifier
      • A Process Handling AI Agent
  • STEP BY STEP GUIDES
    • AI Agent Creation Overview
    • Add a new topic of discussion
    • Use knowledge sources via RAG
    • Adding a structured conversation
    • Add a 3rd party integration
    • Test and tweak your AI Agent
    • Publish your AI Agent
  • CORE CONCEPTS
    • OpenDialog Approach
      • Designing Conversational AI Agents
    • OpenDialog Platform
      • Scenarios
        • Conversations
        • Scenes
        • Turns and intents
      • Language Services
      • OpenDialog Account Management
        • Creating and managing users
        • Deleting OpenDialog account
        • Account Security
    • OpenDialog Conversation Engine
    • Contexts and attributes
      • Contexts
      • Attributes
      • Attribute Management
      • Conditions and operators
      • Composite Attributes
  • CREATE AI APPLICATIONS
    • Designing your application
      • Conversation Design
        • Conversational Patterns
          • Introduction to conversational patterns
          • Building robust assistants
            • Contextual help
            • Restart
            • End chat
            • Contextual and Global No Match
            • Contextual FAQ
          • Openings
            • Anatomy of an opening
            • Transactional openings
            • Additional information
          • Authentication
            • Components
            • Example dialog
            • Using in OpenDialog
          • Information collection
            • Components
            • Example dialog
            • Using in OpenDialog
            • Additional information
          • Recommendations
            • Components
            • Example dialog
            • Additional information
          • Extended telling
            • Components
            • Example dialog
            • Additional information
          • Repair
            • Types of repair
            • User request not understood
            • Example dialog
            • Additional information
          • Transfer
            • Components
            • Example dialog
            • Additional information
          • Closing
            • Components
            • Example dialog
            • Using in OpenDialog
            • Additional information
        • Best practices
          • Use Case
          • Subject Matter Expertise
          • Business Goals
          • User needs
            • Primary research
            • Secondary research
            • Outcome: user profile
          • Assistant personality
          • Sample dialogs
          • Conversation structure
          • API Integration Capabilities
          • NLU modeling
          • Testing strategy
          • The team
            • What does a conversation designer do
          • Select resources
      • Message Design
        • Message editor
        • Constructing Messages
        • Message Conditions
        • Messages best practices
        • Subsequent Messages - Virtual Intents
        • Using Attributes in Messages
        • Using Markdown in messages
        • Message Types
          • Text Message
          • Image Message
          • Button Message
          • Date Picker Message
          • Audio Message
          • Form Message
          • Full Page Message
          • Conversation Handover message
          • Autocomplete Message
          • Address Autocomplete Message
          • List Message
          • Rich Message
          • Location Message
          • E-Sign Message
          • File Upload Message
          • Meta Messages
            • Progress Bar Message
          • Attribute Message
      • Webchat Interface design
        • Webchat Interface Settings
        • Webchat Controls
      • Accessibility
      • Inclusive design
    • Leveraging Generative AI
      • Language Services
        • Semantic Intent Classifier
          • OpenAI
          • Azure
          • Google Gemini
          • Output attributes
        • Retrieval Augmented Generation
        • Example-based intent classification [Deprecated]
      • Interpreters
        • Available interpreters
          • OpenDialog interpreter
          • Amazon Lex interpreter
          • Google Dialogflow
            • Google Dialogflow interpreter
            • Google Dialogflow Knowledge Base
          • OpenAI interpreter
        • Using a language service interpreter
        • Interpreter Orchestration
        • Troubleshooting interpreters
      • LLM Actions
        • OpenAI
        • Azure OpenAI
        • Output attributes
        • Using conversation history (memory) in LLM actions
        • LLM Action Analytics
    • 3rd party Integrations in your application
      • Webhook actions
      • Actions from library
        • Freshdesk Action
        • Send to Email Action
        • Set Attributes Action
      • Conversation Hand-off
        • Chatwoot
    • Previewing your application
    • Launching your application
    • Monitoring your application
    • Debugging your application
    • Translating your application
    • FAQ
    • Troubleshooting and Common Problems
  • Developing With OpenDialog
    • Integrating with OpenDialog
    • Actions
      • Webhook actions
      • LLM actions
    • WebChat
      • Chat API
      • WebChat authentication
      • User Tracking
      • Load Webchat within page Element
      • How to enable JavaScript in your browser
      • SDK
        • Methods
        • Events
        • Custom Components
    • External APIs
  • Release Notes
    • Version 3 Upgrade Guide
    • Release Notes
Powered by GitBook
On this page
  • Introduction
  • See it in action
  • Step by step guide
  • Create an Alias
  • Embed the WebChat Code in Your Website
  1. STEP BY STEP GUIDES

Publish your AI Agent

Ready to launch your AI Agent?

PreviousTest and tweak your AI AgentNextOpenDialog Approach

Last updated 5 months ago

Introduction

Now that you’ve built and refined your AI agent, it’s time to publish it on your website and let it engage with your users. OpenDialog makes this a simple two-step process using aliases, allowing you to easily manage and update your webchat without needing to change the underlying code.

Let’s walk through the steps to get your AI agent live.

Create an Alias and Generate Embed Code

In OpenDialog, an alias acts as a reference point for your WebChat widget. This alias allows you to link different scenarios to your WebChat widget without having to update your website code each time you want to switch or test a new scenario.

See it in action

Step by step guide

Create an Alias

Navigate to the Alias section

  • In the left-hand navigation panel, select your workspace

  • Hover over Scenarios and click on Aliases in the top section of the menu panel

  • View the aliases overview screen

  • Click on ‘Create new alias’

  • Alias Name: This is a unique identifier that follows specific rules. The name must be all lowercase, spaces must be replaced with underscores (_), and it can’t contain numbers, symbols, or uppercase letters.

  • Scenario: Select the scenario you want the alias to reference.

Creating an alias

  • Name your alias

  • Select the scenario you want this alias to reference from the dropdown

  • Click ‘Create Alias’ to generate the embed code

  • Copy the generated embed code using the Copy icon

The power of aliases allows you to easily update your WebChat without ever touching the code again.

Want to switch to a different conversation flow for an upcoming promotion? Simply remap the alias to a new scenario and your website will reflect the update instantly.

Embed the WebChat Code in Your Website

The embed code is the key to getting your AI agent live. Simply embed this code within the body of your website’s HTML just before the closing </body> tag to display the WebChat widget.

If you don’t have access to the underlying code or admin of your website, you can send this embed code to someone in your organisation with the appropriate access.

This will place the WebChat iFrame at the bottom of the page, after all the other content.

Here is an example of an HTML page including the webchat embed code:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <link rel="icon" href="/favicon.ico">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>My website</title>
  </head>
  <body>
    <div id="app">
      <h1>Welcome to my site!</h1>
    </div>
    <script>
      window.openDialogSettings = {
        url: 'your_workspace_URL',
        appKey: 'your_app_key',
        user: {
          custom: {
            selected_scenario: 'your_scenario_id',
            session_lifetime: 0
          }
        },
        customSettings: {
          
          openCta: {
            title: "Hello!👋 Chat with us!",
            icon: "/images/cta-chat-open.svg",
            borderRadius: "50px",
            width: "280px",
            height: "80px",
            background: "#001abf",
          },
        },
      };
    </script>
    <script src='https://[workspace_name].opendialog.ai/dist/nu-webchat-js'></script>
  </body>
</html>

Once your embed code is live on your site, you’re all set!

With these simple steps, your AI agent will be ready to engage your customers, and thanks to OpenDialog’s alias system, you can continue to experiment, iterate, and refine your bot’s performance effortlessly.

Need more flexibility to customise webchat? Check out our documentation.

Webchat SDK
Publishing an AI Agent
Create a new alias by giving it a name and attributing a scenario