Augeo AI Docs
SDKsEvents

Acknowledgements

Acknowledgements

Hosts answer effects with augeo.ack. Join on ack.eventId === event.id.

First settlement wins. Later acks for the same eventId are ignored.

Hosts never send outcome.status unacknowledged. The waiting layer mints that locally.

Cart and wishlist writes are recommend-only. The host composes its own mutations.

Prerequisites

ItemRequirement
Personaloyalty-concierge only
Bundle globalwindow.AugeoChatSdkLoyaltyConcierge
Upward eventCompact augeo.event with a non-empty id

Read Events and Event envelope first.

Constants

NameValueUse
AUGEO_ACK_EVENTaugeo.ackDownward CustomEvent name
Specaugeo.ackValue of spec on every ack
Spec version1.0Value of specversion
Default bound5000 msHOST_MUTATION_ACK_TIMEOUT_MS

subscribeAugeoAcks drops unacknowledged outcomes. Hosts must not send that status.

Ack envelope

FieldRequiredMeaning
specyesConstant augeo.ack
specversionyesConstant 1.0
eventIdyesMatching upward event.id
timeyesAck time in epoch milliseconds
outcomeyesfulfilled or rejected from hosts
effectIdnoEffect id from the upward event
contextnoOptional context bags

Outcomes

outcome.statusHost may sendShape
fulfilledyes{ status: 'fulfilled', data?: unknown }
rejectedyes{ status: 'rejected', error: AugeoError }
unacknowledgednoWidget-only after timeout

Rejected error

FieldRequiredMeaning
codeyesStable machine code
messageyesOne human-readable sentence
classyesFailure class listed below
retryablenoWhether a retry is meaningful
detailsnoIgnore-unknown extension channel
error.classMeaning
offlineMember device is offline
unreachableHost endpoint could not be reached
timeoutHost operation timed out
rate-limitedHost refused the write as too frequent
unauthorizedMember session is not allowed
content-filteredHost blocked the content
cancelledMember or host cancelled the write
serverHost server failure
unknownNone of the classes above

cart.add fulfilled data

Fulfilled cart-add data is CartAddAckResult. Every number must be finite and non-negative.

FieldType
cartTransition.beforePointsTotalnumber
cartTransition.afterPointsTotalnumber
cartTransition.memberPointsBalancenumber

The host supplies all three values from its cart mutation. The widget never calculates, clamps, or substitutes them.

Missing, negative, NaN, or infinite values are not reportable. Extra fields are ignored.

Dispatch a fulfilled ack

const { AUGEO_ACK_EVENT, dispatchAugeoAck } =
  window.AugeoChatSdkLoyaltyConcierge;

const ack = {
  spec: 'augeo.ack',
  specversion: '1.0',
  eventId: event.id,
  time: Date.now(),
  outcome: {
    status: 'fulfilled',
    data: {
      cartTransition: {
        beforePointsTotal: 100,
        afterPointsTotal: 700,
        memberPointsBalance: 500,
      },
    },
  },
};

document.dispatchEvent(
  new CustomEvent(AUGEO_ACK_EVENT, {
    detail: ack,
    bubbles: true,
    composed: true,
  }),
);

// Same payload through the helper:
dispatchAugeoAck(document, ack);

Dispatch a rejected ack

document.dispatchEvent(
  new CustomEvent(AUGEO_ACK_EVENT, {
    detail: {
      spec: 'augeo.ack',
      specversion: '1.0',
      eventId: event.id,
      time: Date.now(),
      outcome: {
        status: 'rejected',
        error: {
          code: 'out_of_stock',
          message: 'Item is out of stock.',
          class: 'unknown',
          retryable: false,
        },
      },
    },
    bubbles: true,
    composed: true,
  }),
);

Subscribe to acks

const { subscribeAugeoAcks } = window.AugeoChatSdkLoyaltyConcierge;

const unsubscribe = subscribeAugeoAcks(document, (ack) => {
  recordHostAck(ack);
});
  1. Read event.id from the upward augeo.event.
  2. Write an augeo.ack with matching eventId.
  3. Call document.dispatchEvent with bubbles and composed.
  4. Write fulfilled or rejected only.
  5. Supply CartAddAckResult data for a fulfilled cart add.

Join the ack to the upward event you are settling. Measured siblings mint a new id.

TopicPage
Handling rulesEvents
Compact field listEvent envelope
Names this widget emitsEvent catalog
JSON schemaEvents v1
Public helpersAPI
Event capability optionsEvent options
Widget configurationConfiguration
Product scopeOverview