Event options
Event options
Event options stamp the application slug, measurement ids, and filter telemetry publish.
They do not write destination events.
The default is on.
Listen with subscribeAugeoEvents.
See Events for the current event path.
See Analytics to map those events onto gtag.
Prerequisites
| Item | Requirement |
|---|---|
| Host page | Serves HTTPS and can load a third-party script |
| Persona | loyalty-concierge |
| Bundle global | window.AugeoChatSdkLoyaltyConcierge |
| Event name | AUGEO_EVENT (augeo.event) |
Load a pinned production loyalty bundle first.
Read Capabilities for the shared true / false / object contract.
Values
| Value | Effect |
|---|---|
| omitted | Events on. No extra ids or filters |
true | Same as omitted |
false | Drops program, placement, application identity, scope, allow, and deny |
| object | Applies the application slug, ids, scope, and glob filters |
Parameters
| Parameter | Default | Type |
|---|---|---|
applicationName | unset | optional string |
environment | unset | optional string |
programId | unset | non-empty string |
placementId | unset | non-empty string |
host | unset | scope array of { tier, id } |
allow | unset | glob string array |
deny | unset | glob string array |
allow and deny filter dictionary names and compact names for telemetry publish.
Blank glob entries are dropped.
Deny wins over allow.
Omitted allow publishes every registered name that is not denied.
applicationName
Optional stable slug for the implementing application.
Set it at initialization.
Do not copy it from the page URL.
Theo-owned embeds pass theo.
A partner embed passes its own slug.
The value is a non-PII integration identifier.
A blank, URL-shaped, or credential-shaped value is dropped.
Omitting it sends no slug.
events: true and events: false also send no slug.
capabilities: {
events: { applicationName: 'theo' },
}Requests send the slug on X-Attribution-Application-Name.
Telemetry copies it to data.context.host.applicationName.
The page location stays {href, title, referrer}.
environment
Optional integrator environment name.
Examples are sandbox, uat, and test.
It stays under data.context.host.
It is not a CloudEvents attribute.
dev, stage, and prod name deployment streams, not this field.
An environment without a kept application slug is dropped.
capabilities: {
events: { applicationName: 'theo', environment: 'sandbox' },
}programId
Pass a program id to stamp measurement context.
const { AugeoAssistant, AUGEO_EVENT } = window.AugeoChatSdkLoyaltyConcierge;
new AugeoAssistant({
container: '#chat-host',
auth: { getToken: () => bearerToken },
capabilities: { events: { programId: 'prog_1' } },
});Emitted measurement context includes programId: 'prog_1'.
placementId
Pass a placement id to stamp measurement context.
capabilities: { events: { placementId: 'place_1' } }Emitted measurement context includes placementId: 'place_1'.
host
Pass host.scope to stamp a host chain on each event.
Each entry is { tier, id }.
tier is the host's word.
id is a nonblank string.
Order entries broad to narrow.
capabilities: {
events: {
programId: 'augeocore_us',
host: {
scope: [
{ tier: 'platform', id: 'encore' },
{ tier: 'program', id: '1963' },
{ tier: 'catalog', id: 'augeocore_us' },
],
},
},
}platform is the external client id from member info.
program is the program id already on the page.
Use the page program id when member info also has one.
Convert a numeric page id to a string.
catalog is the loaded catalog id.
Include catalog only when that catalog profile loaded.
That same id is programId.
Omit catalog when the profile did not load.
Keep platform and program without a catalog.
Do not copy the program id into programId.
Do not add client or program ids to the token body.
Do not set organizationId.
The server writes it.
A host may insert other tiers, such as fi and bank.
The SDK copies scope onto each published event.
Later edits do not change an event already queued.
Member info may include external_client and external_program.
Those fields stay on the shared user query.
They do not fill scope by themselves.
allow
Pass globs to publish only matching dictionary names and compact names.
capabilities: {
events: { allow: ['com.augeo.preference.quiz.*'] },
}Only quiz dictionary names and compact names are eligible to publish. Other registered names are skipped.
deny
Pass globs to drop matching dictionary names and compact names.
capabilities: {
events: {
allow: ['com.augeo.*'],
deny: ['com.augeo.ui.*'],
},
}UI dictionary names and compact names are never published.
Other com.augeo.* names still publish.
Listen for member intent
- Prefer
subscribeAugeoEventsfrom the loyalty global. - Drop details that fail
isAugeoEventEnvelope. - Read Events for envelope handling.
const { subscribeAugeoEvents } = window.AugeoChatSdkLoyaltyConcierge;
subscribeAugeoEvents(document, (event) => {
handleMemberIntent(event);
});Related pages
| Topic | Page |
|---|---|
| Product scope | Overview |
| Constructor fields | Configuration |
| Placement | Surfaces |
| Capability list | Capabilities |
| History | History |
| Privacy | Privacy |
| Message actions | Message actions |
| Chat | Chat |
| Suggestions | Suggestions |
| Wishlist | Wishlist |
| Analytics | Analytics |
| Support | Support |
| Recovery | Recovery |
| Devtools | Devtools |
| DOM events | Events |
| Public types | API |