For the complete documentation index, see llms.txt. This page is also available as Markdown.

Basic Settings

Basic web chat platform settings: platform name, linked AI assistant, return URL, custom domain, allowed embed origins, public access URL, and three embedding methods.

Basic Settings is the first category in the “General” group on the chat platform settings page. It determines the platform name, which AI assistant it uses, and the URL where it provides service. This page explains every field for web platforms. For basic settings on communication platforms such as LINE and Microsoft Teams, which consist of platform credential fields, see the corresponding “Connect a Chat Platform” page. For the overall layout of the settings page and how to access it, see Chat Platform Settings Overview.

1. When to Use These Settings

A marketer wants to add the company's AI customer service assistant to its official website. She opens the web platform's Basic Settings, renames it “Customer Service Assistant,” confirms that it is linked to the “Product Consultation Assistant,” enters the company homepage under Return URL, and adds *.my-company.com under Allowed Embed Origins. After saving, she clicks Embed and gives the JavaScript code to the website engineer. Once launched, only the company's own website can load the customer service assistant; the code will not work if someone else copies it.

2. Field Descriptions

Basic web platform settings: name, AI assistant, return URL, custom domain, allowed embed origins, and public access URL
Basic web platform settings
Field
Description

Name

The name displayed in the chat window title bar, such as “Customer Service Assistant”; required

AI Assistant

The AI assistant that responds on this platform; the same assistant can be connected to multiple platforms

Return URL

The URL users visit when they click Back in the chat window, usually the company homepage

Custom Domain (CNAME)

Serve the chat page from your own domain; see Section 3

Allowed Embed Origins

The embed allowlist; see Section 4

Public Access URL

The automatically generated chat page URL, which can be shared directly or embedded; see Section 5

Name and AI Assistant

Under Name, enter the name you want to display on your website. From the AI Assistant drop-down menu, select the assistant that will answer questions. Switching assistants takes effect immediately, and you do not need to embed the chat window again.

The platform name displayed in the chat window title bar
The platform name appears in the chat window title bar

Return URL

After entering your company website URL, users who click Back on the full-screen chat page will be taken to this URL. The embed preview also uses this URL as its background.

The embed preview uses the website at the return URL as its background
After you add a return URL, the embed preview uses that website as its background

3. Custom Domain (CNAME)

The default public access URL is under chat.maiagent.ai. To use your own domain for the chat page (for example, chat.my-company.com), enter it under Custom Domain (CNAME) and save. The system will request a certificate and configure routing for the domain. After saving, Domain Status appears next to the field:

Status
Meaning
What to do

Checking

The system is configuring routing and a certificate

Wait a few minutes, then refresh the page

DNS Not Ready

Your DNS does not yet point the domain to MaiAgent

Add a CNAME record through your DNS provider

Certificate Not Ready

DNS points to MaiAgent, but the certificate is still being issued

Wait; this usually finishes within a few minutes

DNS Configuration Error

The domain was previously enabled, but its DNS record has been changed or removed

Check the CNAME record with your DNS provider

Enabled

The chat page can now be opened using your domain

The public access URL and embed code will use your domain

The destination address for the CNAME record varies by environment. Contact the Support Center to obtain it. To remove the custom domain and return the chat page to its default URL, clear the field and save.

4. Allowed Embed Origins

What Is This?

Allowed Embed Origins is an embed allowlist. Once configured, only websites on the list can embed this web chat; embed code placed on other websites will not work.

Consider enabling it in the following situations:

  • Prevent unauthorized embedding: Prevent third-party websites from copying your embed code, embedding your customer service bot on their pages, and consuming your conversation quota

  • Security compliance: Meet company or customer security policies that require control over which websites may load the customer service component

This is an advanced security setting. If you do not have either of the needs above, leave the list empty. When the list is empty, any website can embed this web chat.

How It Works

List status
Behavior

Empty (default)

Unrestricted; any website can embed this web chat

Not empty

Allowlist mode: the browser blocks embedding from other domains, and the SDK rejects their setup calls

  • When a blocked domain embeds the chat: The chat component on that page will not finish initializing, so visitors cannot start a conversation

  • Visitors who open the public access URL directly: This setting restricts only embedding. Visitors who open the chat page directly through the public URL are not affected

  • The security mechanism denies access when verification is impossible: When the list is not empty, every embed that fails origin verification is rejected, including misspelled domains and pages using older embed scripts that do not support origin verification

Configuration Steps

1

Find the Field

Under Basic Settings, find Allowed Embed Origins and click + Add.

The Allowed Embed Origins field under Basic Settings
The Allowed Embed Origins field under Basic Settings
2

Add a Domain

Each entry can be an exact origin (https://example.com) or a wildcard domain (*.example.com, which matches example.com and all of its subdomains).

Format
Description

✅ https://www.example.com

Exact origin: allows embedding only on pages at this URL, including the protocol

✅ *.example.com

Wildcard domain: allows embedding on example.com and all of its subdomains (www, shop, blog, etc.)

❌ example.com

An exact origin must include the protocol; without https://, it will not take effect

❌ *.com

The scope is too broad and effectively permits every .com website, defeating the purpose of an allowlist

3

Save and Confirm

After saving the settings, wait about one minute. Then refresh the embedded page on each listed website and confirm that the chat window can still open a conversation normally.

The Allowed Embed Origins field with a completed domain list
Example list containing an exact origin and a wildcard domain

Pre-Enablement Checklist

FAQ

Q: How long does it take for the setting to take effect?

It usually takes effect within about one minute after saving. Refresh any open embedded pages afterward to apply the new setting.

Q: Do I need to list every subdomain individually?

No. A single *.example.com entry matches example.com and all of its subdomains.

Q: What does this setting protect against, and what does it not protect against?

This is protection at the embedding layer: it prevents other websites from embedding this web chat on their pages. It is not authentication. Anyone who knows the public access URL can still open the chat page directly and start a conversation. To control who can start conversations, use Login Settings as well.

Q: What should I do if a configuration error prevents every embedded chat from starting conversations?

Clear the Allowed Embed Origins list and save. Unrestricted access will be restored after about one minute. Then check the domain formats again.

5. Public Access URL and Embedding

The Public Access URL at the bottom of the page is the automatically generated chat page URL. Four actions appear beside it:

Action
Purpose

Copy

Copy the URL to share it directly with users or include it in a QR Code

Visit

Open the chat page in a new tab to test the settings

Embed

Get embed code; see the three embedding methods below

Embed Preview

Preview the embedded result with the return URL's website as the background

Three Embedding Methods

After clicking Embed, use the tabs at the top of the window to switch between:

  • JavaScript: Loads using a <script>; this is the most common option and automatically handles loading and compatibility

  • Iframe: Embeds directly using an <iframe>; suitable for environments where scripts cannot be inserted

  • MaiGPT: A complete ChatGPT-style chat interface (conversation history on the left and the main conversation area on the right) that can remain embedded on the page or expand to full screen when users click a floating button in the lower-right corner

After selecting MaiGPT, configure the Embed Container (targetElement), Locale (locale), and Title (maigptTitle) on the left. The Code Preview on the right updates immediately. Click Copy and paste the code into your website. For complete parameter descriptions, see MaiGPT Window Mode Embedding.

Embed Script Features

The embed.js script provided for JavaScript embedding offers:

  • Duplicate execution prevention: Even if the script is loaded multiple times, it initializes only once

  • Clear error messages: Provides helpful error messages for troubleshooting when loading fails

  • No impact on website loading speed: The script is optimized

  • Compatibility with various website environments and frameworks

Embedding recommendations:

  1. Place the embed script before the </body> tag so the page's primary content loads first

  2. Add the embed script only once on the page to avoid duplication

  3. When using it in an SPA (Single Page Application), see the advanced settings in the technical documentation

Embed preview
Embed preview

6. FAQ

Q: Do I need to embed the chat again after changing the name or AI assistant?

No. The change takes effect immediately after you click Save, and the embed code remains unchanged.

Q: Can the same AI assistant connect to multiple web platforms?

Yes. Each platform has its own name, appearance, and feature toggles, allowing the same assistant to have a different presentation on each website. Go to Customer Service Conversations → Chat Platforms and click Connect a Chat Platform to add one.

Last updated

Was this helpful?