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
  • Where to find
  • What you'll need
  • How to use
  1. CREATE AI APPLICATIONS
  2. 3rd party Integrations in your application
  3. Conversation Hand-off

Chatwoot

This section outlines how you can set up a handoff to live agents using a Chatwoot integration.

PreviousConversation Hand-offNextPreviewing your application

Last updated 11 months ago

Where to find

Conversation Handoff allows you to set up an integration with an external messaging system, for example, Chatwoot. You can therefore find it under the Integrate section of a specific scenario. Once you select 'Create a new Handoff' you will then have the opportunity to create the Handoff of your choice. Select Chatwoot to start setting up your Chatwoot integration.

What you'll need

Once you are set up with an account on Chatwoot for your business, you will need four key elements to set up your OpenDialog - Chatwoot connection:

  • The Domain for the Chatwoot API, which is the following: https://app.chatwoot.com/api/v1/

  • The Account ID for your account can be found via the Chatwoot interface by going into Settings, then Account settings. You will find your Account ID at the bottom of that settings page.

  • The Access Token for your account can be found under Profile settings in the Chatwoot Interface, by clicking on your initials and then selecting Profile settings. You can find your access token on the bottom of the profile settings page and copy it from there.

  • The Inbox ID for the inbox you would like the requests from the conversational application to be submitted to needs to be manually retrieved via the Chatwoot Interface, by going to the inbox you want the request to be sent to. Now go to the address bar for your browser and view the URL, the Inbox ID is the number right after the inbox/ , for exemple: app.chatwoot.com/app/accounts/12345/inbox/4576/conversations/... with 4576 being the inbox-id

How to use

Setting up the Chatwoot handoff in OpenDialog

To set up your Chatwoot handoff, go to the Integrate section, and select Conv. handover from the menu. Use the Create New Handoff button to set up a new Handoff.

On the settings page, give your handoff a name and select Chatwoot as the system you wish to integrate with.

Using the Chatwoot handoff in your scenario

To use your Chatwoot handoff in your scenario, on the Handoff overview page, activate the handoff you have just set up, so that it becomes available for your scenario.

To use the hand-off in your scenario, you can configure the messages for the hand-off via the Message Editor by selecting the Conversation Handover tile

When the user hits this message, the handover system will step into place, and as soon as the user types their request, this will show up in your Chatwoot conversations.

Receiving messages from Chatwoot in OpenDialog

To finalize the integration between Chatwoot and OpenDialog, you will need to connect the two together by referencing your OpenDialog workspace in your Chatwoot Inbox settings.

To do so, go to Chatwoot, the Inbox you have referenced in OpenDialog, and its settings. Update the webhook URL to the following URL, based on your tenant: {tenant}.cloud.opendialog.ai/incoming-chatwoot.

For example: example-workspace.cloud.opendialog.ai/incoming-chatwoot.

In order for your webchat application to be able to return the messages from Chatwoot to webchat, you need to allow the use of websockets. To set this authorisation, go to Interface Settings - Chatbot Controls and set the Use of Websockets toggle to active.

Testing the Chatwoot handoff in your scenario

You can check if your hand-off is successful by testing your conversation in the Preview (Test - Preview) and checking the user context on the right side of your screen.When you hit the hand-off message the user context will update to include handover_success : true.

To set up an integration between your OpenDialog account, and a Chatwoot live agent system - you will need a paying Chatwoot account. To create a Chatwoot account, you can follow the steps mentioned .

Provide the necessary to set up your integration. Hit 'Save' to set up this integration to use in your scenario.

here
account details
Setting up a Chatwoot integration via OpenDialog
Use the Create new Handoff button to set up a new Handoff integration
Update your Chatwoot inbox Webhook URL to be able to receive messages