Augeo AI Docs
SDKsEvents

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

ItemRequirement
Personaloyalty-concierge only
EnvelopeCompact augeo.event with specversion 1.0
Bundle globalwindow.AugeoChatSdkLoyaltyConcierge

Read Event envelope before you switch on type.

How names are produced

FamilyHow it reaches the host
ConversationThis widget emits the name
EngagementDerived from observed UI facts
PreferenceDerived 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.

FieldRequiredMeaning
kindyesproduct, offer, or bundle
idyesStable item identifier
variantIdnoSelected variant
quantitynoRequested quantity
attributesnoAllowlisted extension channel

Conversation names

Conversation occurrences include only allowlisted keys. Forbidden text keys are dropped.

typeOccurrence fields
com.augeo.conversation.session.startedstartedBy, resumed, entryPoint, channel, locale
com.augeo.conversation.session.endedreason, durationMs, turnCount, messageCount, unresolvedEffects
com.augeo.conversation.message.sentmessageId, inputMethod, charCount, attachmentCount, isRetry
com.augeo.conversation.message.receivedmessageId, streamed, blockKinds, blockCount, firstTokenMs, completeMs, truncated
com.augeo.conversation.turn.startedtrigger, turnIndex
com.augeo.conversation.turn.settledendedBy, slotsDeclared, slotsFilled, slotsFailed, slotsDropped, durationMs, toolInvocations
com.augeo.conversation.tool.invokedtoolName, invocationId, argCount, parallelIndex
com.augeo.conversation.tool.settledtoolName, invocationId, phase, durationMs, resultKind, resultCount, failure, recovery
com.augeo.conversation.prompt.selectedpromptId, promptSource, position, offeredCount, presentation
com.augeo.conversation.handoff.offeredhandoffId, destination, trigger, reasonCode
com.augeo.conversation.handoff.acceptedhandoffId, destination, acceptedVia, latencyMs
com.augeo.conversation.decline.shownreason, alternativeOffered, declineId, handoffOffered
com.augeo.conversation.feedback.giventargetKind, targetId, sentiment, hasFreeText, reasonCodes, scale
com.augeo.conversation.launcher.viewedexposureMs, threshold, launcherKind, unreadCount, assistantState
com.augeo.conversation.launcher.activatedactivationSource, launcherKind, presentation, hasSeed
com.augeo.conversation.shell.openedpresentation, entryPoint, hasExistingSession
com.augeo.conversation.shell.closedpresentation, reason, durationMs
com.augeo.conversation.shell.fallbackfrom, to, reason
com.augeo.conversation.error.shownfailure, presentation, recoveryKind, causedByName, blocking, announced
com.augeo.conversation.turn.first_tokenfirstTokenMs, waitBucket, streamId, indicatorShown
com.augeo.conversation.turn.stalledquietMs, elapsedMs, tokensReceived, firstTokenSeen, waitBucket, streamId
com.augeo.conversation.turn.wait_crossedtoBucket, fromBucket, elapsedMs, escalated, waitingOn
com.augeo.conversation.connectivity.lostdetectedBy, pendingEffects, pendingSlots, turnInFlight
com.augeo.conversation.connectivity.restoreddetectedBy, 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.

typeOccurrence fields
com.augeo.engagement.component.loadedcomponentName, items. Optional listId, listName, requestedCount
com.augeo.engagement.item.vieweditem. Optional listId, position, exposureMs
com.augeo.engagement.item.activateditem. Optional listId, position, activation
com.augeo.engagement.item.saveditem. Optional listId, position
com.augeo.engagement.item.unsaveditem. Optional listId, position
com.augeo.engagement.cart.item.addeditem. Optional listId, position
com.augeo.engagement.cart.item.removeditem. Optional listId, position, reason
com.augeo.engagement.cart.item.updateditem, previousQuantity. Optional previousVariantId
com.augeo.engagement.redemption.starteditems. Optional redemptionKind
com.augeo.engagement.item.detail.vieweditem. 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 factDerived preference name
Quiz card viewedcom.augeo.preference.quiz.shown
Quiz card open pressedcom.augeo.preference.quiz.started
Interest selector viewedcom.augeo.preference.quiz.step.viewed
Interest selector next pressedcom.augeo.preference.quiz.step.completed
Confirmed interest profile saveLast step completed plus com.augeo.preference.declared

A refused or unanswered save declares nothing.

typeOccurrence fields
com.augeo.preference.quiz.shownquizId, quizVersion, exposureMs, stepCount, alreadyDeclared. Optional threshold
com.augeo.preference.quiz.startedquizId, quizVersion, stepCount, entryPoint, resumed
com.augeo.preference.quiz.step.viewedquizId, quizVersion, stepIndex, stepKey, stepKind, optionCount, revisit
com.augeo.preference.quiz.step.completedquizId, quizVersion, stepIndex, stepKey, skipped, selectionCount, dwellMs, isLastStep
com.augeo.preference.declaredtaxonomy, 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
  1. Switch on type before you read data.occurrence.
  2. Deduplicate on event.id.
  3. Ignore com.augeo.engagement.redemption.completed.
  4. Treat preference names as derived measured facts.
TopicPage
Handling rulesEvents
Compact field listEvent envelope
Host ack contractAcknowledgements
JSON schemaEvents v1
Public helpersAPI
Event capability optionsEvent options
Widget configurationConfiguration
Product scopeOverview