Events

The Event object

The Event object describes events from your application that can be associated with Users , Companies, and Features. A new Event is created when it is submitted via the API.

Events are typically sent to Schematic to create or update Users or Companies (identify events), or to log usage events (track events) for usage analytics or metering.

Track events can have any number of subtypes denoting what event is being tracked (e.g. query_run, endpoint_added, etc.). Properties (e.g. num_users, num_endpoints, etc.) can be Events but we recommend they be submitted as traits on the Company and User objects.

Attributes

id
string

Unique id generated by Schematic for the object.

feature_id
string

The Schematic id associated with the feature tied to the event.

user_id
string

The Schematic id associated with the user tied to the event.

company_id
string

The Schematic id associated with the company tied to the event.

sent_at
datetime

Datetime when event was sent to Schematic. Format is ISO 8601.

captured_at
datetime

Datetime when event was received by Schematic. Format is ISO 8601.

loaded_at
datetime

Datetime when event was loaded into the Schematic database. Format is ISO 8601.

enriched_at
datetime

Datetime when event was associated with objects in Schematic. Format is ISO 8601.

updated_at
datetime

Datetime of last update to event data. Format is ISO 8601.

environment_id
string

Unique identifier of Schematic environment the event is associated with.

type
string

There are two types of events - identify and track. identify events correspond to Company and User upserts. track events correspond to usage data.

subtype
string

track events can have any number of subtypes denoting what event is being tracked (e.g. query_run, endpoint_added, etc.). Subtypes are grouped together.

processing_status
string

Current status of event in Schematic data pipeline (pending, success, failed, unknown).

body
dictionary

Event payload sent to Schematic (either an identify or track payload).