Documentation Index

Fetch the complete documentation index at: https://help.dialpad.com/llms.txt

Use this file to discover all available pages before exploring further.

Create a Webchat Channel

Prev Next

Use a Webchat channel to provide quick and convenient customer support through your website.

Agents will receive live messages in their Digital Contact Center and can respond without leaving the Dialpad app. Emojis, images, and file sharing are all available to help you improve customer engagement and increase conversion rates.

Let’s dive into the details.

Who can use this

Webchat channel creation and deployment is available to Dialpad Connect, Dialpad Support and Dialpad Sell users with a Digital Engagement license.

Before you begin

Any digital channel you create in the Dialpad Admin Portal will automatically perform the routing to the defined Digital Contact Center once the channel is configured. You can modify how routing occurs and how the conversation is handled before and after routing using the Options and Advanced tabs for Webchat channels.

Here are some basic setup examples you can do with your channels:

  • You can navigate to the Options tab to configure which messages are sent before routing happens or to request contact information before transferring to an agent.

  • You can configure custom routing logic using the "Before agent connection" event in the Advanced tab.

  • Webchat handles the default logic automatically for business hours and agent availability before routing to agents. You can override this logic by using the “Out of business hours” event in the Advanced tab (using an available digital workflow template), if needed. View more about default logic here.

Create a Webchat channel

Create a Webchat channel to start receiving interactions from your website(s).

To create a Webchat channel, head to your Dialpad Admin Settings.

  1. Select Channels and Workflows > Digital Channels

  2. Select Add Digital Channel

    Overview of digital channels with options to add and configure for the company.

  3. Select Webchat as the channel type

  4. Name your channel

  5. Select the Launch Experience

    Note

    When you create an AI Agent, a Web Chat channel is automatically generated with that agent set as its fixed Launch Experience, though you can also assign the AI Agent to additional channels. Use the Options and Advanced tabs to configure human transfer settings for AI Agent channels, or basic automation for non-AI channels.

  6. Select the Digital Contact Center where the channel will be deployed

    Aerolabs Scheduling interface showing channel details and customization options for automation.

  7. Select Add Channel

Customize a Webchat channel

Once your Webchat channel has been created, it's time to customize it. Dialpad lets you upload your own logos, change the colors and fonts, and more!

To customize the appearance of your channel, head to your Dialpad Admin Settings.

  1. Navigate to Channels & Workflows > Digital Channels

  2. Select the desired channel

  3. Select Appearance

  4. Update these details, as desired:

    • colors

    • font

    • logo

    • avatar

  5. Select Save changes

Deploy a Webchat channel

Now that you’ve customized the appearance of your Webchat experience, it’s time to deploy it.

To deploy a Webchat channel, head to your Dialpad Admin Settings.

  1. Navigate to Channels & Workflows > Digital Channels

  2. Select the desired channel

  3. Select Deploy
    Aerolabs Scheduling interface showing code snippet for deploying AI Agent widget.

From the Deploy Section, you can copy the short link to test your connection (recommended), or select Copy code to copy and paste the code snippet into your website.

Deployment details

The integration script must be included within the the the HTML page, and the clickable element must have the ID dx_chatbot_fab_id

<script async type="module" src="https://dxbeta.dx.dialpad.com/dxclient/dist/dialpad-chatbot.es.js"> </script> 
<script> window.dxe = {server: https://dxbeta.dx.dialpad.com }; </script>

The following script must be added to the button element to launch the client.

<img id="dx_chatbot_fab_id" 
data-dxchannelid="cfd15683ab42443983a7c4f2ac60c808" 
data-dxprovemail="5130893811646464@5130893811646464.sandbox.dialpad.com"/>

The button can be any HTML element as long as the id is set to dx_chatbot_fab_id

The dx_chatbot_fab_id supports the following attributes:

Attribute

Required

Description

data-dxchannelid

Required

dxchannelid defines which experience to launch.  The channelid is available on the Deploy page.

data-dxprovemail

Required

This attribute is used to uniquely identify the company account.  This can also be a providerid.  

data-dxwfvars

Optional

The value of the attribute will be comma-separated key, value pairs that need to be available in the workflows.  This is useful for passing context information to the digital experience workflows from the portal.

Tip

For a standalone chat experience, have your customers access your chat via the shortlink or QR code.

Here are a few examples of how to deploy your chatbot on popular website hosting platforms and systems.

Wordpress

In Wordpress, the Head, Footer and Post Injections plugin is used to inject script in the header and place the floating action button (FAB).

  1. Navigate to Settings

  2. Select Header and Footer

  3. Copy the scripts from the Deploy section

The <Head> page section of each page must include the chat script for persistent or sticky sessions.

Add the FAB and the initialization before the </body>

Squarespace

The Squarespace website builder supports code injection from the Website Tools.

  1. Select Utilities

  2. Select Website Tools

  3. Select Code injection

  4. Copy the script found in the Deploy section

Ruby on Rails apps

Dialpad’s Ai Chatbot client can be integrated with Ruby on Rails apps. Refer to the sample code and instructions below to learn how to integrate our Ai Chatbot with a RoR app

Step 1: Create a partial

Locate the app/view/shareddirectory for your app and create a new view file named _dialbot.html.erb

Copy and paste the following code into your partial.

<div
  id="dx_chatbot_fab_wrapper_id" 
  style="background-color:#7C52FF;border-radius:50%;box-sizing:border-box;display:flex;height:56px;overflow:hidden;padding:12px;width:56px;position:absolute;bottom:16px;right:16px;z-index:123;">
  <img 
    data-dxchannelid=<%= channel_id %>
    data-dxprovemail=<%= provider_id %>
    id="dx_chatbot_fab_id"
    src="<%= server %>/kpd-static/providers/0/webchat/default/images/fab-icon.png"
    style="clip-path:circle(50%);object-fit:contain;height:auto;width:100%;"
  />
</div>

<script>window.dxe = { "server": "<%= server %>" };</script>
<script async type="module" src="<%= server %>/dxclient/dist/dialpad-chatbot.es.js"></script>

Step 2: Use the partial in other views

Use the partial in other views, for example:

<%= render partial: "shared/dialbot", locals: { channel_id: '45194947cdd740129c48fb3c10706a3d', provider_id: '5646620347596800@dialpad.com', server: 'https://lighthouse.dx.dialpad.com' } %>

Parameters

channel_id The unique ID of the WebChat channel.

provider_id The provider ID or email.

server The server URL with zone.

Android apps

Dialpad Ai Chatbot client can be integrated with native Android apps. You can use our Android SDK and Swift package to enable this integration.

This article provides references and links to our public GitHub repositories that host the Android SDK and Swift package for native Android apps.

The repository contains usage and installation guide, sample app and SDK source.

The key features of these native bindings are:

  • Bi-directional Communication:

    • Your Android app can send commands to the chatbot using DialpadChatbotCommand and NotificationCenter

    • The chatbot can send events to your Android app using DialpadChatbotEvent and NotificationCenter

  • WKWebView-based Implementation: Leverages WKWebView for rendering the chatbot interface.

  • Compose Support: The package includes a DialpadChatbotView for easy integration with Jetpack Compose and SwiftUI

iOS apps

Dialpad Ai Chatbot client can be integrated with native Android apps. You can use our iOS SDK and Swift package to enable this integration.

This article provides references and links to our public GitHub repositories that host the iOS SDK and Swift package for native iOS apps.

The repository contains usage and installation guide, sample app and SDK source.

The key features of these native bindings are:

  • Bi-directional Communication:

    • Your iOS app can send commands to the chatbot using DialpadChatbotCommand and NotificationCenter

    • The chatbot can send events to your iOS app using DialpadChatbotEvent and NotificationCenter

  • WKWebView-based Implementation: Leverages WKWebView for rendering the chatbot interface.

  • Compose Support: The package includes a DialpadChatbotView for easy integration with Jetpack Compose and SwiftUI

More information

Questions on how to manage your Digital Contact Center? Be sure to read this Help Center article for more information.

Configure automation for your Webchat channel

Use the Options and Advanced tabs to customize automation for key conversation moments set to the defined Launch Experience.

For channels using an AI Agent as the Launch experience, use the Options and Advanced tabs to customize what happens when the conversation is transferred to a human agent.

Customize Options for your Webchat channel

To customize Options for your webchat channel, go to your Dialpad Admin Settings.

  1. Select Channels & Workflows > Digital Channels

  2. Select the desired Webchat channel

  3. Select the Options tab

    Aeroplabs scheduling interface showing options for customer interaction and automation settings.

  4. Update these details, as needed:

    • Greeting message: shown when a customer first contacts the channel or when an AI agent escalates to a human agent.

    • Request contact information: prompts for the customer’s name, email, phone number, or address.

    • Waiting message: shown while the customer waits for an agent.

    • Business email for after-hours contacts: used to notify your team when agents are unavailable.

    • Survey: shown after the interaction.

  5. Select Save changes

Use the Advanced tab to link published Digital or Shared Workflows to Webchat events.

Webchat events are instances within a webchat session that can trigger a workflow. Webchat events include:

  • When conversation starts: Trigger a workflow when a conversation begins, or an AI Agent escalates.

  • Out of business hours: Override the default logic for checking business hours and the agent's availability.

    Note

    This event should be used only when there is a need to override the default logic for checking business hours or agent availability. See the Default logic for more details.

  • Before agent connection: Run a workflow before the conversation is queued for a human agent.

  • Queue timeout or no agent available: Set fallback actions when a customer has been waiting in the queue, and no human agent responds before the timeout.

  • Before customer survey: Customize the experience before the customer survey is shown.

  • After customer survey: Define follow-up actions once the survey is completed.

  • After the agent session has closed: Set what happens after the session with the human agent ends.

Note

Workflows are created in Channels & Workflows > Workflows.

To link a Webchat channel to a workflow, go to your Dialpad Admin Settings.

  1. Select Channels & Workflows > Digital Channels

  2. Select the desired Webchat channel

  3. Select the Advanced tab

    Aeroplabs scheduling interface showing workflows for digital channels and auto reply options.

  4. Select the Event that triggers the workflow

  5. Select the Workflow that is triggered by the Webchat event

  6. (Optional) Add additional events, if needed

  7. Select Save changes

How Options and Advanced settings interact

System Processing Order

The system processes the Options configuration and the events in the Advanced tab in the following order:

  1. When conversation starts (Advanced tab): This triggers first when a new conversation is initiated.

    Note

    If the Launch Experience is an AI Agent, this triggers when the AI Agent escalates to a human operator — not at initial customer contact.

  2. Out of business hours (Advanced tab): If configured, overrides the default availability logic to check business hours. See Default logic for more details.

    Note

    This uses Business email for after-hours contacts (Options tab) if systememail is configured to send an email to notify a customer has reached out during out-of-business hours.

  3. Greeting message (Options tab): The initial message shown to the customer.

  4. Request contact information (Options tab): Prompts the customer for name, email, phone, address.

  5. Before agent connection (Advanced tab): Runs before the conversation is queued for a human agent.

  6. Waiting message (Options tab): Sent while the customer waits for an available agent.

  7. At this point, the routing to a human agent happens. A system message is present saying: “You are placed in a queue. Please wait…” (This message can be modified from Historical Administration)

  8. Queue timeout or no agent available (Advanced tab): Triggered if no agent responds before the timeout threshold.

  9. Before customer survey (Advanced tab): Triggers before the survey is shown (only if Survey is enabled in Options).

  10. Survey (Options tab): Triggers the survey configured.

  11. After customer survey (Advanced tab): Triggers after the survey is completed (only if Survey is enabled in Options).

  12. After the agent session has closed (Advanced tab): Triggers after the session with the human agent ends (use this when no survey is configured).

Default Availability Logic

When no custom workflow is attached to the "Out of business hours" event in the Advanced tab, webchat channels use the following built-in availability logic to handle customer contacts.

It checks business hours and agent availability, and uses the systememail variable (configured in the Options tab under "Business email for after-hours contacts") to determine whether to send an email notification.

Flowchart illustrating customer service contact procedures and email handling steps.

Frequently asked questions

What types of images can I share?

Users can upload the following file types:

  • gif

  • png

  • jpg

  • aac

  • mp4

  • amr

  • mp3

  • ogg

  • 3gp

  • pdf

  • doc

  • xls

  • ppt

  • docx

  • xlsx

  • pptx

Can I share multiple attachments at once?

No, only one file can be uploaded at a time.

Are web chats secure?

Yes! We encrypt all API calls and web socket data.

Where can I find analytics for my Webchat channel?

To monitor your Webchat channel metrics, check out the All digital view in your Dialpad Analytics.

Are eParams supported?

No eParams is not supported.