Create a Webchat v3 endpoint
- In the navigation menu of the Cognigy interface, select a project.
- In the navigation menu of the project, go to Deploy > Endpoints.
- On the Endpoints page, click + New endpoint.
- In the New endpoint dialog, select the Webchat v3 channel and click Create endpoint.
- On the Setup tab, enter a unique name in the Endpoint name field.
- In the Target section, select a relevant flow or agent from the list.
- Click Save.
Configure general settings
The following general settings are available within this endpoint:- Endpoints overview
- Data protection & analytics
- Transformer functions
- NLU connectors
- Session management
- Real-time translation settings
- Agent Copilot
- File storage
- Copilot
- Inject and Notify
Live preview
In the Webchat v3 endpoint editor, you can view your changes in real time while configuring your Webchat widget. To open the live preview, click the preview bar on the right with theConfigure specific settings
Customize Webchat to meet your specific needs. You can adjust colors and add features such as file uploads to enhance the effectiveness of your agent. The settings are on the Layout, Behavior, Compliance, and Advanced tabs of the endpoint. Any updates you make are instantly reflected when you load or reload your website with Webchat linked to the endpoint.Setup
Integration
Layout
Style presets
The Style presets settings on the Layout tab offer predefined dimensions and text display behavior for the Webchat widget. The style presets let you quickly customize your Webchat widget without manually adjusting the CSS customization settings, the Advanced layout settings, or the Webchat layout settings. You can select the following style presets:Classic: The classic, smaller Webchat widget with bordered agent messages.
Modern: A larger, wider Webchat widget with borderless agent messages.
Slick: A larger but narrower Webchat widget with bordered agent messages on a gray background.
Classic
Classic
Modern
Modern
Slick
Slick
Webchat layout
The Webchat layout settings offer parameters for changing the Webchat layout, including options to customize the title and logo of the Webchat interface. You can also specify separate logos and names for messages from agents and human agents.Webchat icon
The Webchat icon settings let you customize the icon displayed on your website to open the Webchat widget. You can also animate the icon and set the animation frequency and speed. After setting the icon animation, you can preview the animation in the icon field.Colors
The Colors settings let you customize the colors of the Webchat v3 interface, including the primary and secondary colors, the chat interface and message colors, and the text link color.Persistent menu
The Persistent menu settings ensure quick access to different conversation stages, guide users, offer features, share information, and enhance the overall user experience.Advanced layout settings
The Advanced layout settings provide parameters for managing the chat interface, focusing on input behavior, HTML styling, and JavaScript.Demo Webchat settings
Demo Webchat lets you test integrations with different providers and preview Webchat’s appearance before deployment. It’s a valuable tool for ensuring your Webchat functions as expected before launch. To configure it, go to the Layout tab and open the Demo Webchat settings card. For more information on how to use this feature, refer to Demo Webchat.Webchat plugins
To add a link to a Webchat plugin, go to the Layout tab. In the Demo Webchat settings card, turn on Activate Demo Webchat, and then, in the Webchat plugins section, click Add plugin URL. You can add multiple plugins. For more information on creating and triggering plugins, refer to Webchat plugins.Home screen
The Home screen settings on the Layout tab enable personalization of welcome messages, backgrounds, and button texts, creating a user-friendly and brand-aligned initial chat interface.Conversation starters
The Conversation starters settings offer predefined messages to prompt interactions with agents, enhancing user engagement and streamlining conversation flow. You can customize messages, choose an interaction type, for example, a postback payload or a URL, and add up to five starters.Previous conversations
The Previous conversations settings enable users to access past interactions with the agent within the last 30 days through a dedicated button on the home screen. You can customize the conversation screen’s button text and header to enhance usability and personalization.Teaser message
The Teaser message settings on the Layout tab include personalized teaser messages, the display of conversation starters, and the ability to define specific actions upon user interaction, such as sending messages or directing users to URLs.Behavior
Webchat behavior
The Webchat behavior settings on the Behavior tab enhance communication by enabling typing indicators, customizing input text, enabling speech-to-text and text-to-speech features, adjusting message delay, ensuring focus after interaction, and alerting users to internet connection status.Start behavior
The Start behavior settings offer features for initiating conversations, including starting with a text field, a button click, or an automatic message, with customization options.Attachment upload
The Attachment upload settings offer features to upload files in Webchat, customize the upload area text, and choose where files are stored, such as AWS, Azure, or Google Cloud, along with the necessary connection credentials.Business hours
The Business hours settings help manage business hours in Webchat. They enable you to restrict Webchat availability by specifying behavior outside business hours, customize messages, set the time zone, and define operational days.Unread messages
The Unread messages settings help users stay informed about unread messages in Webchat. They include features such as displaying message counts, previews, and notification sounds for timely responses.User inactivity
The User inactivity settings allow Webchat to detect when an end user goes silent after a Node that expects an input, for example, Question, Optional Question, or Wait for Input Nodes. After the timeout configured in the Enable User Inactivity Node, Cognigy.AI considers the user inactive and injects an input into the Flow with the text and data configured in this section. Use it to re-prompt the user, route abandoned conversations, or end them cleanly. User inactivity events are written to the Logs page with the[User Inactivity] prefix.
Injected input example
Injected input example
- Webchat v3 Endpoint:
- Injected text —
The user has been inactive - Injected data —
{"reason": "no_reply"}
- Injected text —
- Enable User Inactivity Node:
- Timeout —
30
- Timeout —
userInactivity object contains the following fields:Build a flow with user inactivity handling
The following example Flow asks the user whether they are ready for their order and handles a user who doesn’t respond.1. Configure the Endpoint
1. Configure the Endpoint
- In the left-side menu of the Project, go to Deploy > Endpoints and open your Webchat v3 Endpoint.
- On the Behavior tab, in the User inactivity section, turn on Activate user inactivity.
- In the Action list, select Inject into current Flow.
- In the Injected text field, enter the text that the Flow receives when the user is inactive, for example,
You seem to have disconnected. - Optional. In the Injected data field, enter a JSON object, for example,
{ "reason": "no_reply" }. - Save changes.
2. Greet the User
2. Greet the User
- In the Flow editor, add the AI Agent Node.
- In the AI Agent Node, configure the AI Agent to greet the user, for example, with a short welcome message.
- Save changes.
3. Activate User Inactivity Detection
3. Activate User Inactivity Detection
- Below the Default Node of the AI Agent Node, add the Enable User Inactivity Node.
- In the Timeout field, specify
60. This sets the timeout to one minute. - Save changes.
4. Ask the User
4. Ask the User
- Below the Enable User Inactivity Node, add the Question Node.
- In the Question Type list, select Yes / No.
- In the Output Type list, select Text with Quick Replies.
- In the Text field, enter
Are you ready for your order?. - Click the Yes quick reply and do the following:
- In the Select Button Type list, select Postback Value.
- In the Postback Value field, enter
yes.
- Click the No quick reply and do the following:
- In the Select Button Type list, select Postback Value.
- In the Postback Value field, enter
no.
- Save changes.
5. Handle the Answer
5. Handle the Answer
- Below the Question Node, add the If Node.
- In the Condition field, click Use Advanced Editor and enter
input.result === false. - Below the Then child Node, do the following:
- Add the Disable User Inactivity Node. This stops the inactivity detection, so the user isn’t prompted while they get ready.
- Below the Disable User Inactivity Node, add the Say Node and enter the text
Okay, I'll wait. Just let me know when you are ready..
- Below the Else child Node, do the following:
- Add the Question Node.
- In the Question Type list, select Text.
- In the Text field, enter
What would you like?. This Node waits for the user’s answer. If the user doesn’t respond within the timeout, the injected inactivity input answers the question. - Below the second Question Node, add the Say Node and enter the text
{{input.text}}. This token outputs the injected text from the Endpoint settings.
- Save changes.
6. Test the Flow
6. Test the Flow
- Open Demo Webchat for your Endpoint.
- When the AI Agent asks
Are you ready for your order?, select Yes. The AI Agent then asksWhat would you like?. - Don’t type or send anything for longer than one minute.
- Check that the AI Agent responds with
You seem to have disconnected. - On the Logs page, check for entries that start with
[User Inactivity]. They report when inactivity is detected and the input is injected. - Start a new conversation and answer
No. Check that the AI Agent responds withOkay, I'll wait. Just let me know when you are ready.and that no inactivity message follows after one minute, because the Disable User Inactivity Node turned detection off.
Chat options
The Chat options card on the Behavior tab includes settings for activating chat features, such as quick replies and conversation rating, and for adding a footer section for additional information or navigation links.Activate chat options
The Activate chat options settings offer features such as quick replies, conversation rating, and a footer, enhancing user interaction. You can customize the title of the Chat options screen to personalize the user experience.Quick replies
The Quick replies settings improve chat interactions with predefined response options that you can customize and manage, and that direct users to URLs or trigger specific responses, enhancing the overall conversational experience.Text-to-speech
The Text-to-speech settings allow you to convert text to speech, with options to customize the toggle label and set the toggle to be enabled by default.Conversation rating
The Conversation rating settings include a chat rating widget that lets users rate their experience and provide feedback. You can customize text prompts and confirmation messages to ensure a user-friendly feedback process.Allow deleting conversations
By default, end users can’t delete conversations in the Webchat widget. To allow end users to delete the current conversation, activate the Allow deleting conversations parameter. After activation, they can delete the current conversation on the Chat options screen. If you want your end users to be able to delete all conversations, configure the Allow deleting all conversations parameter in the Previous conversations section. Note that after deletion, the conversation is removed from the Webchat widget on the end user’s side but is still available in the Cognigy OData endpoint, Insights, and contact profile.Footer
The Footer settings offer a customizable footer section for the chat interface. You can set a custom title for the footer, specify a URL for redirection upon clicking, and add up to two title-URL pairs for additional content.Compliance
Privacy notice
The Privacy notice settings on the Compliance tab add privacy notices to the chat interface. They include options to activate a custom privacy notice, set its title and text, customize the submit button, and define the link title and URL for the privacy policy. These features ensure users are informed about data handling practices and consent to them, fostering trust and compliance with privacy regulations. Cognigy automatically records user acceptance of the Privacy Notice in the Contact Profile. Accepting the privacy notice in the chat doesn’t count as a user input in terms of billable conversations.Advanced
The Advanced tab offers customization features, such as adding a watermark and activating maintenance mode for transparent communication during updates. The Webchat custom settings further enhance customization by allowing specific UI adjustments and feature integrations through JSON formatting.Watermark
The Watermark settings let you personalize the chat interface with a watermark that suits your branding or platform, enhancing recognition and customization options.Maintenance
The Maintenance settings let you activate maintenance mode in a chat service, with options to inform users, disable the widget, or hide it. You can customize the maintenance messages displayed to users.Webchat custom settings
The Webchat custom settings on the Advanced tab offer advanced options to change the appearance and behavior of your Webchat beyond the standard settings. You specify these settings in the Custom JSON field using JSON format. Ensure the JSON is correctly formatted to prevent potential crashes of the Webchat widget. Use the Webchat custom settings to:- Overwrite UI text and values configured in the endpoint settings
- Change and translate UI text and ARIA labels. You can use dynamic strings, such as
{name}or{time}, as described in the embedding documentation. - Add values from embedding files not present in the GUI
- Specify parameters for your custom Webchat version
- Use features from a later Cognigy version while using an earlier one
JSON example: change Webchat colors
JSON example: change Webchat colors
JSON example: translate Webchat texts
JSON example: translate Webchat texts