Event Dictionary

The Events Table

Search by name or description; filter by source, domain, or destination. Click any row to expand its payload, source file, and dispatch mechanism.

How Events Flow

Two pipelines converge on Segment, which fans out to downstream tools. Backend events are dispatched from PHP event classes; frontend events from a trackEvent() mixin.

The Base Payload Envelope

Every backend event carries a common Segment track envelope; only the per-event data differs. There are two generations of base contract, and they nest data differently — worth knowing when you query Segment.

{
  "userId": "<user uuid | anonymous-…>",
  "event": "User Viewed A Lesson",
  "properties": {
    // ChurnZero identity keys
    "accountExternalId": "…",
    "contactExternalId": "…",
    "sp_global_organization_id": "…",
    "sp_global_user_id": "…",
    "external_reseller_id": "…",
    "meta": { "origin": "Platform", "accountUser": {…} },
    "data": { /* event-specific */ }
  },
  "timestamp": 1740000000,
  "context": { "active": true, "ip": "…" },
  "integrations": { "ChurnZero": true }
}

{
  "userId": "<user uuid | uniqid()>",
  "event": "Course Stored",
  "properties": {
    // eventDetails placed directly here —
    // no meta / data nesting
    "created_by": "<uuid>",
    "uuid": "<uuid>"
  },
  "timestamp": "2026-08-21T00:00:00+00:00",
  "context": { "active": true, "ip": "…" },
  "integrations": { "ChurnZero": true }
}

By Domain

The same catalog, grouped by owning domain — the per-domain view the old Confluence tree promised but never filled in. Each list links into the filtered table above.

Frontend Events

The 36 events fired from platform-frontend, by dispatch mechanism. Store-routed events get the full Segment envelope; direct-mixin events also hit Hotjar; onboarding events use the survey payload builder.

Store-routed (Segment envelope) (27)

Direct mixin (Segment + Hotjar) (7)

Onboarding (survey payload builder) (2)

Methodology & Freshness

This page is a static snapshot generated by extracting event definitions from both repositories. To keep it fresh, re-run the commands below and regenerate.

Backend enumeration

# From platform-backend/src — the authoritative catalog is the class glob,
# NOT the seeders (seeders register only 26 of 135 to a destination).
grep -rlE "extends SegmentEvent(Contract)?\b" app --include='*.php' | wc -l   # 135
grep -rhoE "eventName = ['\"][^'\"]+['\"]" app --include='*.php'
grep -rhoE "const EVENT_NAME = ['\"][^'\"]+['\"]" app --include='*.php'
grep -rA15 "eventDetails = \[" app --include='*.php'   # payload keys

Frontend enumeration

# From platform-frontend
grep -rhoE "trackEvent\(['\"][^'\"]+['\"]" src --include='*.vue' --include='*.js' | sort -u

To keep this fresh

• Re-run the greps above; diff the backend class count and the frontend unique-name list against the stat strip.
• Re-run the generator (prototypes/.build-event-dictionary.py) to rebuild the embedded data and this page.
• Flag naming inconsistencies you find — e.g. the frontend fires both User Bookmarked a Lesson and lowercase User bookmarked a lesson, which Segment sees as two events.