Overview
Overview
The Chat SDK loyalty widget is an embeddable concierge for program members. It mounts on your host site and talks to the production AI API.
This page defines the public integration model. It also lists host duties and links every task area in the guide.
Prerequisites
| Item | Requirement |
|---|---|
| Host page | Serves HTTPS and can load a third-party script |
| DOM mount | A container element exists before you construct the assistant |
| Member token | Your backend supplies a bearer token for the signed-in member |
| Persona | Public embeds use the loyalty-concierge persona only |
Integration model
The supported third-party path is script embed.
Load one production IIFE bundle.
Read the constructor from the bundle global.
Construct AugeoAssistant with a container and token callback.
Pass AugeoAssistantOptions.
Required fields are container and auth.getToken.
Optional fields are auth.onFailure, apiBaseUrl, onError, branding, surface, capabilities, and host.
The production CDN script is the supported host install path.
Production bundle
| Constant | Value |
|---|---|
| Production CDN host | https://sdks.augeoai.net |
| Persona path segment | loyalty-concierge |
| IIFE global | window.AugeoChatSdkLoyaltyConcierge |
| Custom element | chat-sdk-loyalty-concierge |
| Pinned production script | https://sdks.augeoai.net/chat-sdk/loyalty-concierge/0.10.0/index.js |
| Pinned script pattern | https://sdks.augeoai.net/chat-sdk/loyalty-concierge/<version>/index.js |
| Latest script path (development) | https://sdks.augeoai.net/chat-sdk/loyalty-concierge/latest/index.js |
Pin a version in production traffic. Upgrade only when you choose a new release.
The production bundle already targets the production API.
Omit apiBaseUrl unless you must override it.
Host responsibilities
Your host owns authentication, mount layout, and member-side effects.
| Duty | Host action |
|---|---|
| Auth | Implement auth.getToken so every request gets a current bearer token |
| Auth recovery | Handle auth.onFailure when the server rejects an expired token |
| Mount target | Provide a CSS selector that resolves before construction |
| Layout | Choose inline, modal, or sidebar through surface.type |
| Branding | Set branding.agentName and branding.theme for partner colors |
| Intent handling | Act on recommend-only events such as cart, wishlist, click, and support |
| Lifecycle | Call destroy() when the host route or session ends |
| Errors | Route onError into host telemetry or user messaging |
auth.getToken must return a string synchronously.
A Promise stringifies in the Authorization header.
The widget recommends actions. It does not mutate your cart or wishlist itself.
surface.type is the only field that selects the shell.
Omitted surface resolves to inline.
Task areas
| Task | Page |
|---|---|
| Embed and tear down in minutes | Quick start |
| Set root options | Configuration |
| Choose inline, modal, or sidebar | Surfaces |
| Embed personalized reward cards | For You widget |
| Recolor partner UI | Branding |
| Toggle features | Capabilities |
| Handle member intents | Events |
| Forward events to gtag | Analytics |
| Review public types | API |
| Fix common integration failures | Common issues |
Search widget
The Search SDK is a separate browser bundle with its own mount and authentication callback. It provides recent searches, recommendations, typeahead, catalog results, and an optional handoff to chat.
Start with the Search SDK overview or follow its quick start.
Related links
- Start embedding: Quick start
- Set root options: Configuration
- Public constructor surface: API