Augeo AI Docs
SDKsSchemas

Events v1

Events v1

This page documents the compact augeo.event envelope for the public loyalty widget.

Prerequisites

  • Read Events for host handling guidance.
  • Gate consumers on spec augeo.event and specversion 1.0.
  • Match each type against Event catalog.

Version

ItemValue
Documentation versionv1
Spec (spec)augeo.event
Spec version (specversion)1.0
Type version (typeversion)Dictionary-defined per event type
Schema draftJSON Schema draft-07

Trace metadata

Use this table to confirm the page matches the published schema file.

FieldValue
Source filenameaugeo-event-envelope.schema.json
Schema $idhttps://kigo-digital.github.io/augeo-ai-sdks/chat-sdk/augeo-event-envelope.schema.json
Documentation versionv1
Source digestsha256:339b5e263f080c009593fe24f4c677dc82255a2a4e8ce73d44bea3bd6b254b13

Root object

Compact augeo.event envelope emitted by the public loyalty widget.

AspectValue
Typeobject
Required fieldsspec, specversion, id, type, typeversion, time, class, source, correlation, data
Additional propertiesAllowed

Root fields

FieldTypeRequiredDefaultDescription
specconst "augeo.event"Yes—Envelope family for upward widget events.
specversionconst "1.0"Yes—CloudEvents-compatible spec version.
idstringYes—Unique id for this emission.
typestringYes—Dictionary event name.
typeversionintegerYes—Payload version for this event type.
timeintegerYes—Emission time in epoch milliseconds.
class"observed" | "measured"Yes—Observed fact or measured derivation.
sourceEventSourceYes——
subjectstringNo—Optional subject of the event.
gestureKeystringNo—Optional stable key for one member gesture.
correlationEventCorrelationYes——
dataEventDataYes——

Definitions

EventSource

Surface and instance that produced the event.

AspectValue
Typeobject
Required fieldssurface, instanceId
Additional propertiesAllows additional properties.

Fields

FieldTypeRequiredDefaultDescription
surfacestringYes—Originating UI surface.
instanceIdstringYes—Instance id of that surface.

EventCorrelation

Optional join keys for conversation, effect, and causation.

AspectValue
Typeobject
Required fields—
Additional propertiesAdditional properties use type string.

Fields

FieldTypeRequiredDefaultDescription
conversationIdstringNo—Active conversation or thread id.
turnIdstringNo—Turn id inside the conversation.
slotIdstringNo—Interaction slot id.
effectIdstringNo—Effect id waiting for a host ack.
interactionIdstringNo—Interaction id for this gesture.
causationIdstringNo—Id of the causing event.

EventData

Occurrence payload and context bags.

AspectValue
Typeobject
Required fieldsoccurrence, context
Additional propertiesAllows additional properties.

Fields

FieldTypeRequiredDefaultDescription
occurrenceobjectYes—Type-specific occurrence fields.
contextobjectYes—Shared context bags.

Full schema

The JSON below is the complete schema document.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://kigo-digital.github.io/augeo-ai-sdks/chat-sdk/augeo-event-envelope.schema.json",
  "title": "AugeoEventEnvelope",
  "description": "Compact augeo.event envelope emitted by the public loyalty widget.",
  "type": "object",
  "required": [
    "spec",
    "specversion",
    "id",
    "type",
    "typeversion",
    "time",
    "class",
    "source",
    "correlation",
    "data"
  ],
  "additionalProperties": true,
  "properties": {
    "spec": {
      "const": "augeo.event",
      "description": "Envelope family for upward widget events."
    },
    "specversion": {
      "const": "1.0",
      "description": "CloudEvents-compatible spec version."
    },
    "id": {
      "type": "string",
      "description": "Unique id for this emission."
    },
    "type": {
      "type": "string",
      "description": "Dictionary event name."
    },
    "typeversion": {
      "type": "integer",
      "description": "Payload version for this event type."
    },
    "time": {
      "type": "integer",
      "description": "Emission time in epoch milliseconds."
    },
    "class": {
      "type": "string",
      "enum": [
        "observed",
        "measured"
      ],
      "description": "Observed fact or measured derivation."
    },
    "source": {
      "$ref": "#/definitions/EventSource"
    },
    "subject": {
      "type": "string",
      "description": "Optional subject of the event."
    },
    "gestureKey": {
      "type": "string",
      "description": "Optional stable key for one member gesture."
    },
    "correlation": {
      "$ref": "#/definitions/EventCorrelation"
    },
    "data": {
      "$ref": "#/definitions/EventData"
    }
  },
  "definitions": {
    "EventSource": {
      "type": "object",
      "required": [
        "surface",
        "instanceId"
      ],
      "additionalProperties": true,
      "description": "Surface and instance that produced the event.",
      "properties": {
        "surface": {
          "type": "string",
          "description": "Originating UI surface."
        },
        "instanceId": {
          "type": "string",
          "description": "Instance id of that surface."
        }
      }
    },
    "EventCorrelation": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Optional join keys for conversation, effect, and causation.",
      "properties": {
        "conversationId": {
          "type": "string",
          "description": "Active conversation or thread id."
        },
        "turnId": {
          "type": "string",
          "description": "Turn id inside the conversation."
        },
        "slotId": {
          "type": "string",
          "description": "Interaction slot id."
        },
        "effectId": {
          "type": "string",
          "description": "Effect id waiting for a host ack."
        },
        "interactionId": {
          "type": "string",
          "description": "Interaction id for this gesture."
        },
        "causationId": {
          "type": "string",
          "description": "Id of the causing event."
        }
      }
    },
    "EventData": {
      "type": "object",
      "required": [
        "occurrence",
        "context"
      ],
      "additionalProperties": true,
      "description": "Occurrence payload and context bags.",
      "properties": {
        "occurrence": {
          "type": "object",
          "additionalProperties": true,
          "description": "Type-specific occurrence fields."
        },
        "context": {
          "type": "object",
          "additionalProperties": true,
          "description": "Shared context bags."
        }
      }
    }
  }
}