38.1 Installation Prerequisites

Before installing an AIUNIFY Chat Agent on a website, confirm that:

  • The Agent is configured.
  • At least one useful Knowledge Source has been reviewed.
  • The Agent has been tested in Playground.
  • The Agent is published.
  • The production website origin is included under Allowed Origins.
  • Restricted Paths are configured when necessary.

38.2 Finding the Embed Snippet

Open the Agent's Settings page and locate Embed on your site.

The Settings page displays the Agent-specific installation snippet and provides a Copy snippet action.

38.3 Publish Before Installation

If the Agent is still Draft, the Settings page warns that you must publish the Agent before the snippet can run for visitors.

The launch snapshot also reports whether widget installation is available.

38.4 Agent-Specific Script

The generated snippet is a one-line asynchronous script loader containing the Agent's ID.

The deployment pattern is equivalent to:

<script src=".../widget/widget.js?..." data-agent-id="AGENT-ID" async></script>

Always copy the generated snippet from the Agent rather than manually inventing an Agent ID or widget URL.

38.5 Where to Paste the Snippet

The interface instructs you to paste the snippet before:

</body>

on every webpage where that Agent should be available.

38.6 Site-Wide Installation

If your website platform supports a global footer, global code injection area, theme layout, or shared template, the snippet can normally be placed there so it loads across eligible pages.

Restricted Paths can then prevent the widget from mounting on selected areas.

38.7 Allowed Origin Enforcement

Installing the script does not override the Agent's Allowed Origins. The website origin must still be authorized.

If the script exists in the page but the Agent does not initialize, review Allowed Origins first.

38.8 Restricted Paths

Even on an allowed origin, the widget will not mount on URL paths matching the Agent's Restricted Paths configuration.

38.9 Cache-Busting Widget URL

The generated widget URL includes a version/hash query value. AIUNIFY Chat generates this value so browsers and cache layers can retrieve updated widget builds rather than remaining indefinitely on an older cached bundle.

38.10 Testing the Installation

After installation:

  1. Open an allowed website page.
  2. Confirm the widget appears in the expected position.
  3. Open the widget.
  4. Send a realistic test message.
  5. Confirm the Conversation appears in AIUNIFY Chat.
  6. If Lead capture is configured, test that workflow as well.
  7. Open a Restricted Path and confirm the widget remains hidden there.

38.11 If the Widget Does Not Appear

Check the Agent's publication state, Allowed Origin, Restricted Paths, installation location, and copied snippet before changing application code.

Write Your Comment