Skip to main content

Core Events

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

These events ship with epilot and are identical in every organization. To define an event on your own entity attributes, see Custom Events.

See the API Changelog for the full history of additions and changes to core 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#

ServiceMeterReadingAdded

ServiceMeterReadingAdded#

Customer​

CustomerRequestSubmitted

CustomerRequestSubmitted#

CustomerDetailsUpdated

CustomerDetailsUpdated#

Billing Account​

InstallmentUpdated

InstallmentUpdated#

ServiceInstallmentChange

ServiceInstallmentChange#

PaymentMethodUpdated

PaymentMethodUpdated#

BillingAddressUpdated

BillingAddressUpdated#

BillingAccountConnectionRemoved

BillingAccountConnectionRemoved#

Files​

FileCreated

FileCreated#

Orders & Tariffs​

OrderSubmission

OrderSubmission#

TariffChange

TariffChange#

Grid​

GridConnectionRequested

GridConnectionRequested#

ERP Sync​

OnDemandSyncContractRequested

OnDemandSyncContractRequested#

OnDemandSyncCustomerRequested

OnDemandSyncCustomerRequested#

Automation​

These events are triggered manually via automation.

GeneralRequestCreated

GeneralRequestCreated#

LocationMoveRequested

LocationMoveRequested#

TerminateContractRequested

TerminateContractRequested#

InvoiceSimulationRequested

InvoiceSimulationRequested#