For AI agents: the complete documentation index is available at https://docs.clickmax.io/en/llms.txt, the full documentation bundle is available at https://docs.clickmax.io/en/llms-full.txt, and this page is available as Markdown at https://docs.clickmax.io/en/features/create/webchat/enable-webchat.md.
  • English
  • Enable WebChat on your page

    Publish the WebChat channel and paste the embed code before </body> on the page where the chat should appear. Two steps: publish the channel, then embed the code. Any workspace member can do this — no specific role is required.

    Before you start

    • WebChat is in gradual rollout. If you cannot see the WebChat area under Create, your account has not received the feature yet.
    • You need to be able to edit the target page's HTML (to paste code before </body>).

    Steps

    1. Open Create → WebChat and create a new channel. Pick a template and confirm.

    2. In the channel editor, adjust the bot flow (Editor tab) and the appearance (Design tab). In the center of the Editor tab, switch between Flow (the step map — click a node to edit it) and Preview (the working chat, exactly as the visitor will see it). See Chat preview.

    3. Click Publish. This saves the channel as active — the link and the widget only work once the channel is published. If you try to leave the editor with unsaved changes, a prompt asks whether to Keep editing or Leave without saving.

    4. Open the sharing tab and copy the embed code. The snippet looks like this:

      <div data-cx-livechat="YOUR_CHANNEL_ID"></div>
      <script async src="https://YOUR_GATEWAY/sdk/livechat.js"></script>

      Always copy the real code from the tab — the channel id and the address come already filled in.

    5. Paste the code before </body> on the pages where the chat should appear.

    6. (Optional) In the allowed domains (CORS) field, enter one origin per line (for example https://mysite.com). Left empty, any site can embed it.

    Would rather not embed it on a site? Use the full-screen public link, on the same sharing tab: click Copy link. It opens the chat full screen and also requires the channel to be published.

    Fullscreen chat inside your site

    With Display mode set to Fullscreen (Design tab), the Embed code changes: the chat fills only the <div> area, where you paste the code on the page, instead of covering the whole site.

    <div data-cx-livechat="YOUR_CHANNEL_ID" data-cx-mode="embed" style="height: 640px"></div>
    <script async src="https://YOUR_GATEWAY/sdk/livechat.js"></script>
    • Paste the code where the chat should appear (it doesn't need to go before </body>).
    • Adjust the height in the <div> style. The width follows the space it sits in. Without a height, the chat uses 600px.
    • In this mode there's no floating button and no close button: the chat is already open.

    Customize the fullscreen address

    On the Sharing tab, the Fullscreen address card sets how the chat link looks. Changes apply after you save or publish.

    1. In Custom link, type the end of the link (for example support). The Public link (fullscreen) then uses that name instead of the channel code. The old link with the code keeps working.
    2. (Optional) In Custom domain, pick a connected domain from your account. The chat also opens at https://your-domain/<path>.
    3. In Path on the domain, type the path (for example contact-us). Empty = uses the Custom link (or the channel code).

    Use only letters, numbers, hyphens (-) and underscores (_). Messages you may see when saving:

    • This link is already in use. Choose another one. — another channel already uses that custom link.
    • This link can’t look like an ID. Choose another one. — the name looks like a channel code.
    • This path is already in use on this domain. Choose another one. — another of your channels already uses that path on the same domain.

    If the domain shows as not connected, the address only works after the connection finishes. The page on your own domain is accepted even when the Allowed domains (CORS) list is filled in.

    Chat preview

    The Preview (Editor tab) and the center of the Design tab show the real widget — the same one that runs on your site — already including the changes you haven't saved yet.

    • Switch between Bubble (the floating button in the corner of a sample page, which opens the chat window) and Fullscreen (the chat taking the whole page, like the public link). The preview starts in the display mode chosen on the Design tab.
    • You can walk through the flow as a visitor: fill in the capture step, click the options and type answers. Nothing is sent or saved — no conversation or contact is created. On an AI step, the preview follows the fallback path without classifying the answer.
    • If an AI SDR serves the channel's account (in My agents), the AI SDR on this channel card shows above the steps, with the agent's name and how it replies. The preview doesn't simulate the agent: it only answers in the published chat, after the Bot flow ends.
    • Every change in the editor restarts the preview conversation. Use Restart conversation to start over whenever you want.
    • On the Design tab the bubble starts closed, showing the floating button with its tooltip, badge and animation; click it to open the conversation. On the Editor tab the conversation opens right away.
    • The chat shows your channel's colors, exactly as the visitor sees them, in both the light and dark platform themes. Only the sample page around it follows your theme.

    The widget is mounted by the Clickmax Browser SDK. For the attributes the <div data-cx-livechat> accepts, see the Browser SDK reference (Portuguese).

    With Consent (LGPD) turned on (Design tab), the chat shows an authorisation checkbox above the reply area, with the text and privacy link you set. The visitor can only move on after ticking it.

    As soon as the box is ticked, the notice leaves the screen and does not come back in that conversation — the questions and answer options stay clear, with nothing on top of them. If the visitor reloads the page or comes back later in the same browser, the consent still counts and the notice is not shown again. If you change the text or the privacy link, the notice shows up again so everyone accepts the new terms.

    When the conversation reaches your team

    While the visitor goes through the Bot flow, the conversation stays out of the Live Chat inbox. It joins the queue when:

    • the flow reaches an Attendant step or the → Talk to an attendant target. With Assign to filled in on the step, the conversation goes straight to that person;
    • the flow ends some other way (End or the last step) and the visitor writes a message.

    The visitor sees a notice in the chat when the conversation joins the queue ("You’ve been transferred to our team…") and when someone from the team joins it ("An agent joined the conversation."). This also applies when the AI SDR is the one handing the conversation to the team.

    On a channel without a Bot flow, the conversation joins the queue on the visitor's first message, even with a Welcome message.

    If it didn't work

    • The fullscreen chat covers the whole site: copy the code again with Display mode set to Fullscreen — the <div> needs data-cx-mode="embed".
    • The widget does not appear: confirm the channel is published and that the page's domain is in the allowed domains (CORS) list — or leave that list empty.
    • You cannot see the WebChat area: the feature has not been released to your account yet — see no permission.
    • The chat loads but errors when sending a message: see the error codes (Portuguese).