Feature Overview
Chat Embed

Chat Embed

Chat Embed lets you turn a RealTimeX workspace into a website chat experience. In the product, this area has two views:

  • Configs: create, edit, enable, disable, and publish embed configurations.
  • Chats: monitor widget usage, recent threads, and public hosting status.

Each embed inherits the selected workspace's default model behavior, knowledge, instructions, and tools unless the embed configuration overrides part of that experience.

Before you create an embed

Make sure the source workspace already behaves the way you want in normal chat. If the workspace has the wrong instructions, weak retrieval, or the wrong model behavior, the embed will inherit those problems.

Open Settings > Chat Embed, then select Create embed.

Configure the embed

The creation flow is split into a few practical groups.

Basics

  • Workspace: choose the workspace that powers the widget.
  • Response mode: choose Chat for broader conversation or Query for document-grounded answers. See Chat Modes.
  • Allowed domains: optionally restrict which websites are allowed to load the widget.

Behavior guardrails

  • Max chats per day: total 24-hour usage cap for that embed.
  • Max chats per session: 24-hour limit for a single visitor session.
  • Message history limit: how many previous messages RealTimeX includes as chat context.

Branding and layout

  • Display mode: floating, fullscreen, or inline.
  • Trigger mode: launcher or manual.
  • Position: launcher placement for floating layouts.
  • Inline target and size: where an inline embed mounts and how large it renders.
  • Visual styling: assistant name, greeting, brand image, assistant avatar, launcher icon, and chat bubble colors.

The right-side preview updates as you change these settings, which is the fastest way to validate the end-user experience before you publish it.

Publish the widget

Every embed row includes a Code action that opens the script snippet you place on your site. That snippet is the handoff between RealTimeX and your webpage.

Depending on how RealTimeX is running, the publish flow can behave differently:

  • Public URL available: use the generated snippet directly for internet-facing sites.
  • Local-only or development mode: the snippet may be suitable for local testing but not for a public site yet.
  • Public URL required: RealTimeX will ask you to provision or recover managed public hosting before you publish.

Manage existing embeds

The Configs table shows the workspace behind each widget, total chat volume, active domain restrictions, and when the embed was created.

From the same table you can:

  • copy the current script snippet
  • enable or disable an embed without deleting it
  • open the edit flow to change workspace, guardrails, or branding
  • delete an embed configuration permanently

Monitor embed activity

The Chats view is a lightweight dashboard for embed traffic. It summarizes:

  • total widgets
  • active widgets
  • workspaces using embeds
  • embed threads
  • embed messages
  • latest activity time

It also lists recent embed threads so you can jump straight into the underlying workspace conversation when you need to review what a visitor asked.

Public hosting and availability

When the app surface supports it, RealTimeX also shows a public hosting snapshot with the current state, managed URL, connector state, and last successful heartbeat.

If managed hosting is available, admins can provision, recover, pause, resume, or release that public URL from the same Chat Embed area. If it is not available, embed configs can still be created, but public deployment depends on your own network or hosting path.

Common checks

If an embed is not behaving the way you expect:

  1. Confirm the selected workspace answers correctly in normal chat.
  2. Verify the domain allowlist includes the site where you are testing.
  3. Check that the embed is enabled.
  4. If the code dialog warns about local-only mode, provision or recover public hosting before publishing to a public website.