Skip to main content

Core Events

epilot's core event catalog with built-in event schemas, examples, and schema definitions.

See the API Changelog for recent changes to events and APIs.

Event Architectureโ€‹

Events follow a consistent structure with common metadata fields and event-specific payloads. Each event may include hydrated entity data from the entity graph.

Common Event Fieldsโ€‹

All events include these fields:

  • _org_id: epilot tenant/organization ID
  • _event_time: ISO 8601 timestamp when event occurred
  • _event_id: Unique event identifier (ULID)
  • _event_name: Event name from catalog
  • _event_version: Schema version number
  • _event_source: Source that triggered the event

Built-in Event Schemasโ€‹

Meteringโ€‹

MeterReadingAdded

MeterReadingAdded#

Customerโ€‹

CustomerDetailsUpdated

CustomerDetailsUpdated#

Billing Accountโ€‹

InstallmentUpdated

InstallmentUpdated#

PaymentMethodUpdated

PaymentMethodUpdated#

BillingAddressUpdated

BillingAddressUpdated#

Automationโ€‹

These events are triggered manually via automation.

GeneralRequestCreated

GeneralRequestCreated#

LocationMoveRequested

LocationMoveRequested#

TerminateContractRequested

TerminateContractRequested#

BillingAccountConnectionRemoved

BillingAccountConnectionRemoved#

ServiceMeterReadingAdded

ServiceMeterReadingAdded#