Event catalog
Event catalog
This page lists every compact name this widget emits or derives. Occurrence keys are the only fields hosts should read.
Conversation names are emitted by this widget. Engagement and preference names are derived measured facts.
Preference names are never authored as design-system names. This widget does not emit com.augeo.engagement.redemption.completed.
Prerequisites
| Item | Requirement |
|---|---|
| Persona | loyalty-concierge only |
| Envelope | Compact augeo.event with specversion 1.0 |
| Bundle global | window.AugeoChatSdkLoyaltyConcierge |
Read Event envelope before you switch on type.
How names are produced
| Family | How it reaches the host |
|---|---|
| Conversation | This widget emits the name |
| Engagement | Derived from observed UI facts |
| Preference | Derived from observed UI facts |
typeversion follows the dictionary definition for that name. class is observed or measured.
Listed occurrence keys are the fields this widget may emit. Omitted keys are absent.
Item subject
Engagement item fields use this shape. Attribute keys are displayName and monetized only.
| Field | Required | Meaning |
|---|---|---|
kind | yes | product, offer, or bundle |
id | yes | Stable item identifier |
variantId | no | Selected variant |
quantity | no | Requested quantity |
attributes | no | Allowlisted extension channel |
Conversation names
Conversation occurrences include only allowlisted keys. Forbidden text keys are dropped.
type | Occurrence fields |
|---|---|
com.augeo.conversation.session.started | startedBy, resumed, entryPoint, channel, locale |
com.augeo.conversation.session.ended | reason, durationMs, turnCount, messageCount, unresolvedEffects |
com.augeo.conversation.message.sent | messageId, inputMethod, charCount, attachmentCount, isRetry |
com.augeo.conversation.message.received | messageId, streamed, blockKinds, blockCount, firstTokenMs, completeMs, truncated |
com.augeo.conversation.turn.started | trigger, turnIndex |
com.augeo.conversation.turn.settled | endedBy, slotsDeclared, slotsFilled, slotsFailed, slotsDropped, durationMs, toolInvocations |
com.augeo.conversation.tool.invoked | toolName, invocationId, argCount, parallelIndex |
com.augeo.conversation.tool.settled | toolName, invocationId, phase, durationMs, resultKind, resultCount, failure, recovery |
com.augeo.conversation.prompt.selected | promptId, promptSource, position, offeredCount, presentation |
com.augeo.conversation.handoff.offered | handoffId, destination, trigger, reasonCode |
com.augeo.conversation.handoff.accepted | handoffId, destination, acceptedVia, latencyMs |
com.augeo.conversation.decline.shown | reason, alternativeOffered, declineId, handoffOffered |
com.augeo.conversation.feedback.given | targetKind, targetId, sentiment, hasFreeText, reasonCodes, scale |
com.augeo.conversation.launcher.viewed | exposureMs, threshold, launcherKind, unreadCount, assistantState |
com.augeo.conversation.launcher.activated | activationSource, launcherKind, presentation, hasSeed |
com.augeo.conversation.shell.opened | presentation, entryPoint, hasExistingSession |
com.augeo.conversation.shell.closed | presentation, reason, durationMs |
com.augeo.conversation.shell.fallback | from, to, reason |
com.augeo.conversation.error.shown | failure, presentation, recoveryKind, causedByName, blocking, announced |
com.augeo.conversation.turn.first_token | firstTokenMs, waitBucket, streamId, indicatorShown |
com.augeo.conversation.turn.stalled | quietMs, elapsedMs, tokensReceived, firstTokenSeen, waitBucket, streamId |
com.augeo.conversation.turn.wait_crossed | toBucket, fromBucket, elapsedMs, escalated, waitingOn |
com.augeo.conversation.connectivity.lost | detectedBy, pendingEffects, pendingSlots, turnInFlight |
com.augeo.conversation.connectivity.restored | detectedBy, outageMs, autoRetried, awaitingMemberAction |
Message and tool occurrences never include member text or tool arguments.
Conversation example
{
spec: 'augeo.event',
specversion: '1.0',
id: 'evt_01hmsg',
type: 'com.augeo.conversation.message.sent',
typeversion: 1,
time: 1735689600000,
class: 'observed',
source: { surface: 'chatsdk', instanceId: 'conversation' },
correlation: { conversationId: 'thr_1', turnId: 'turn_1' },
data: {
occurrence: {
messageId: 'msg_1',
inputMethod: 'typed',
charCount: 12,
attachmentCount: 0,
isRetry: false,
},
context: {},
},
}Engagement names
These names are derived. Optional keys are omitted when unknown.
type | Occurrence fields |
|---|---|
com.augeo.engagement.component.loaded | componentName, items. Optional listId, listName, requestedCount |
com.augeo.engagement.item.viewed | item. Optional listId, position, exposureMs |
com.augeo.engagement.item.activated | item. Optional listId, position, activation |
com.augeo.engagement.item.saved | item. Optional listId, position |
com.augeo.engagement.item.unsaved | item. Optional listId, position |
com.augeo.engagement.cart.item.added | item. Optional listId, position |
com.augeo.engagement.cart.item.removed | item. Optional listId, position, reason |
com.augeo.engagement.cart.item.updated | item, previousQuantity. Optional previousVariantId |
com.augeo.engagement.redemption.started | items. Optional redemptionKind |
com.augeo.engagement.item.detail.viewed | item. Optional listId, position, entryPoint |
activation is open, select, or navigate. entryPoint for detail view is card-activation.
com.augeo.engagement.redemption.started stays a name this widget can derive. A host that records the redemption start on the server denies that name. Other hosts may still publish it.
Do not listen for com.augeo.engagement.redemption.completed. This widget never emits it.
Cart add example
Ack com.augeo.ui.effect.requested. That observed id is the eventId hosts must join.
{
spec: 'augeo.event',
specversion: '1.0',
id: 'evt_01hpress',
type: 'com.augeo.ui.effect.requested',
typeversion: 1,
time: 1735689600000,
class: 'observed',
source: { surface: 'product_card', instanceId: 'card_42' },
gestureKey: 'gesture_1',
correlation: { effectId: 'fx_1' },
data: {
occurrence: {
effectKind: 'redeem',
item: { kind: 'product', id: '42', quantity: 1 },
},
context: {},
},
}The measured cart-add sibling is a post-settlement fact. It mints a new id and sets causationId to the source.
{
spec: 'augeo.event',
specversion: '1.0',
id: 'evt_01hcart',
type: 'com.augeo.engagement.cart.item.added',
typeversion: 1,
time: 1735689601000,
class: 'measured',
source: { surface: 'product_card', instanceId: 'card_42' },
gestureKey: 'gesture_1',
correlation: {
effectId: 'fx_1',
causationId: 'evt_01hpress',
},
data: {
occurrence: {
item: { kind: 'product', id: '42', quantity: 1 },
},
context: {},
},
}Write eventId as the observed source id. Do not ack the measured sibling id. See Acknowledgements.
Preference names
These five names are derived from design-system emissions. This widget never authors them as design-system names.
| Observed UI fact | Derived preference name |
|---|---|
| Quiz card viewed | com.augeo.preference.quiz.shown |
| Quiz card open pressed | com.augeo.preference.quiz.started |
| Interest selector viewed | com.augeo.preference.quiz.step.viewed |
| Interest selector next pressed | com.augeo.preference.quiz.step.completed |
| Confirmed interest profile save | Last step completed plus com.augeo.preference.declared |
A refused or unanswered save declares nothing.
type | Occurrence fields |
|---|---|
com.augeo.preference.quiz.shown | quizId, quizVersion, exposureMs, stepCount, alreadyDeclared. Optional threshold |
com.augeo.preference.quiz.started | quizId, quizVersion, stepCount, entryPoint, resumed |
com.augeo.preference.quiz.step.viewed | quizId, quizVersion, stepIndex, stepKey, stepKind, optionCount, revisit |
com.augeo.preference.quiz.step.completed | quizId, quizVersion, stepIndex, stepKey, skipped, selectionCount, dwellMs, isLastStep |
com.augeo.preference.declared | taxonomy, labels, declaredVia, operation, quizId, labelCount |
labels entries are { id, rank? } with coded taxonomy ids only.
Preference example
{
spec: 'augeo.event',
specversion: '1.0',
id: 'evt_01hquiz',
type: 'com.augeo.preference.quiz.shown',
typeversion: 1,
time: 1735689600000,
class: 'measured',
source: { surface: 'activity_card', instanceId: 'quiz_interests_card' },
correlation: { causationId: 'evt_01hview' },
data: {
occurrence: {
quizId: 'quiz_interests',
quizVersion: 3,
exposureMs: 1200,
stepCount: 5,
alreadyDeclared: false,
},
context: {},
},
}Observed UI facts
The widget also forwards these observed design-system names. Preference and engagement names are derived from them.
type |
|---|
com.augeo.ui.component.rendered |
com.augeo.ui.component.viewed |
com.augeo.ui.action.pressed |
com.augeo.ui.effect.requested |
com.augeo.ui.effect.settled |
- Switch on
typebefore you readdata.occurrence. - Deduplicate on
event.id. - Ignore
com.augeo.engagement.redemption.completed. - Treat preference names as derived measured facts.
Related pages
| Topic | Page |
|---|---|
| Handling rules | Events |
| Compact field list | Event envelope |
| Host ack contract | Acknowledgements |
| JSON schema | Events v1 |
| Public helpers | API |
| Event capability options | Event options |
| Widget configuration | Configuration |
| Product scope | Overview |