Skip to content

Key Schema

The S3 object key encodes all event metadata. No separate index table is needed — LIST + prefix is the query engine.

For the full machine-readable specification see spec/key-schema/.

Structure

events/{company-id}/{group-id}/{warehouse-id}/source/{source-id}/{aggregate-type}/{aggregate-id}/{version}/{event-type}

Segments

SegmentDescriptionExample
company-idTop-level tenant identifieracmecorp
group-idLogical warehouse group within a companynordics
warehouse-idSpecific warehouse integrationongoing-wms
source-idSpecific webshop or source systemwoo-no
aggregate-typeType of aggregateorders
aggregate-idUnique aggregate identifier (UUID v4)f47ac10b-58cc-...
versionZero-padded 10-digit version number0000000001
event-typePascalCase event type nameOrderReceived

Query Patterns

IntentPrefix
All events for a tenantevents/acmecorp/
All events for a warehouse groupevents/acmecorp/nordics/
All events for a warehouseevents/acmecorp/nordics/ongoing-wms/
All events from a specific sourceevents/acmecorp/nordics/ongoing-wms/source/woo-no/
Full history of one orderevents/acmecorp/nordics/ongoing-wms/source/woo-no/orders/{id}/

Released under the MIT License.