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.eventand specversion1.0. - Match each
typeagainst Event catalog.
Version
| Item | Value |
|---|---|
| Documentation version | v1 |
Spec (spec) | augeo.event |
Spec version (specversion) | 1.0 |
Type version (typeversion) | Dictionary-defined per event type |
| Schema draft | JSON Schema draft-07 |
Trace metadata
Use this table to confirm the page matches the published schema file.
| Field | Value |
|---|---|
| Source filename | augeo-event-envelope.schema.json |
Schema $id | https://kigo-digital.github.io/augeo-ai-sdks/chat-sdk/augeo-event-envelope.schema.json |
| Documentation version | v1 |
| Source digest | sha256:339b5e263f080c009593fe24f4c677dc82255a2a4e8ce73d44bea3bd6b254b13 |
Root object
Compact augeo.event envelope emitted by the public loyalty widget.
| Aspect | Value |
|---|---|
| Type | object |
| Required fields | spec, specversion, id, type, typeversion, time, class, source, correlation, data |
| Additional properties | Allowed |
Root fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
spec | const "augeo.event" | Yes | — | Envelope family for upward widget events. |
specversion | const "1.0" | Yes | — | CloudEvents-compatible spec version. |
id | string | Yes | — | Unique id for this emission. |
type | string | Yes | — | Dictionary event name. |
typeversion | integer | Yes | — | Payload version for this event type. |
time | integer | Yes | — | Emission time in epoch milliseconds. |
class | "observed" | "measured" | Yes | — | Observed fact or measured derivation. |
source | EventSource | Yes | — | — |
subject | string | No | — | Optional subject of the event. |
gestureKey | string | No | — | Optional stable key for one member gesture. |
correlation | EventCorrelation | Yes | — | — |
data | EventData | Yes | — | — |
Definitions
EventSource
Surface and instance that produced the event.
| Aspect | Value |
|---|---|
| Type | object |
| Required fields | surface, instanceId |
| Additional properties | Allows additional properties. |
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
surface | string | Yes | — | Originating UI surface. |
instanceId | string | Yes | — | Instance id of that surface. |
EventCorrelation
Optional join keys for conversation, effect, and causation.
| Aspect | Value |
|---|---|
| Type | object |
| Required fields | — |
| Additional properties | Additional properties use type string. |
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
conversationId | string | No | — | Active conversation or thread id. |
turnId | string | No | — | Turn id inside the conversation. |
slotId | string | No | — | Interaction slot id. |
effectId | string | No | — | Effect id waiting for a host ack. |
interactionId | string | No | — | Interaction id for this gesture. |
causationId | string | No | — | Id of the causing event. |
EventData
Occurrence payload and context bags.
| Aspect | Value |
|---|---|
| Type | object |
| Required fields | occurrence, context |
| Additional properties | Allows additional properties. |
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
occurrence | object | Yes | — | Type-specific occurrence fields. |
context | object | Yes | — | 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."
}
}
}
}
}Related links
- Read the events overview: Events
- Inspect the event envelope: Event envelope
- Look up event types: Event catalog
- Review public types: API