Augeo AI Docs
SDKsCapabilities

Recovery

Recovery

Recovery configures failure retry and optional leave or report exits. The default is off. leave and report are a URL string or a callback. Omitting an entry does not invent that exit.

Prerequisites

ItemRequirement
Host pageServes HTTPS and can load a third-party script
Personaloyalty-concierge
Bundle globalwindow.AugeoChatSdkLoyaltyConcierge

Load a pinned production loyalty bundle first. Read Capabilities for the shared true / false / object contract.

Values

ValueEffect
omittedNo recovery destinations
falseNo recovery destinations
trueEnabled with no exits
objectKeeps only supplied onRetry, leave, report

Blank URL strings are dropped. A dropped field does not add that exit.

Parameters

ParameterDefaultType
onRetryunset() => void or Promise
leaveunsetURL string or callback
reportunsetURL string or callback

onRetry

Pass a host hook that runs when the member retries.

const { AugeoAssistant } = window.AugeoChatSdkLoyaltyConcierge;

new AugeoAssistant({
  container: '#chat-host',
  auth: { getToken: () => bearerToken },
  capabilities: {
    recovery: {
      onRetry: () => retryHostFlow(),
    },
  },
});

Retry still uses the widget replay path. onRetry also runs so the host can refresh local state.

leave

Pass a URL or callback to offer a leave exit. Omit it to keep leave off the notice.

capabilities: { recovery: { leave: '/account' } }

The failure notice includes Leave and goes to /account.

capabilities: { recovery: { leave: () => closeHostChat() } }

Leave runs closeHostChat instead of navigating.

report

Pass a URL or callback to offer a report exit. Omit it to keep report off the notice.

capabilities: { recovery: { report: '/feedback' } }

The failure notice includes Report and goes to /feedback.

capabilities: {
  recovery: {
    leave: '/account',
    report: () => openHostReport(),
  },
}

Leave and Report both appear. Report runs openHostReport. Leave still navigates to /account.

TopicPage
Product scopeOverview
Constructor fieldsConfiguration
PlacementSurfaces
Capability listCapabilities
HistoryHistory
PrivacyPrivacy
Message actionsMessage actions
ChatChat
SuggestionsSuggestions
WishlistWishlist
Event optionsEvent options
AnalyticsAnalytics
SupportSupport
DevtoolsDevtools
DOM eventsEvents
Public typesAPI