Augeo AI Docs
SDKsCapabilities

Privacy

Privacy

Privacy controls first-launch consent and the Privacy menu. The default is off. Pass an options object to configure the program policy and consent experience.

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
omittedConsent gate and Privacy menu stay off
falseConsent gate and Privacy menu stay off
trueEnables first-launch consent and the Privacy menu
{}Same as true

Options

FieldTypeDefaultEffect
policyobjectdefault label, no linkProgram's privacy-policy link
policy.labelstringPrivacy PolicyText displayed for the policy; blank labels use the default
policy.urlstringno linkActive program's privacy-policy destination
consentbooleantrueShows the first-launch consent gate and Privacy menu

Set the program policy

Pass the active program's policy destination as capabilities.privacy.policy.url. Set capabilities.privacy.policy.label to customize its visible text. Omitted, empty, or whitespace-only labels default to “Privacy Policy”. The SDK trims surrounding whitespace from a configured label.

capabilities: {
  privacy: {
    policy: {
      label: 'Program privacy notice',
      url: 'https://program.example/privacy',
    },
  },
}

Use an absolute HTTP or HTTPS URL. The SDK trims surrounding whitespace and normalizes the URL. Relative URLs, unsafe schemes, embedded credentials, malformed URLs, and embedded control characters produce no link.

The same label and destination appear in the consent gate, composer agreement, and Privacy Settings. Custom composer disclaimers and compact mode retain their existing behavior.

There is no default policy URL. Programs using the Augeo policy must supply its URL explicitly. With a missing, blank, or invalid value, Privacy Settings omits the link. The gate and default composer keep their agreement text with the configured label as plain text.

The host owns program selection and policy configuration. When switching programs, destroy the existing assistant and construct another with the new program's URL and authentication.

Configure disclosure only

Pass consent: false to keep the composer link without the consent gate or Privacy menu.

new AugeoAssistant({
  container: '#chat-host',
  auth: { getToken: () => bearerToken },
  capabilities: {
    privacy: { policy: { url: 'https://program.example/privacy' }, consent: false },
  },
});

Enable privacy

Pass true or an options object to show first-launch consent and the Privacy menu. An options object also lets you supply the program policy.

const { AugeoAssistant } = window.AugeoChatSdkLoyaltyConcierge;

new AugeoAssistant({
  container: '#chat-host',
  auth: { getToken: () => bearerToken },
  capabilities: { privacy: { policy: { url: 'https://program.example/privacy' } } },
});

Members must accept consent before chat. The Privacy menu becomes available.

Keep privacy off

Omit the key or pass false.

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

The consent gate does not run. The Privacy menu stays hidden.

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