The Formo Event Spec outlines how to send event data to Formo’s APIs and the proper format to capture events using Formo’s SDKs.

​
Events API

The Formo API spec supports the following calls, each gathering important data about the user:

API callDescription
IdentifyIdentifies a visitor or user
PageRecords when a user visits a new page in your application
TrackRecords custom events with arbitrary data
ResetResets all stored information about the previously identified user
ConnectRecords when a user connects their wallet to your application
DisconnectRecords when a user disconnects their wallet
ChainRecords when a user switches to a different blockchain network
SignatureRecords signature requests and their statuses
TransactionRecords blockchain transactions and their statuses

​
Event Properties

The event data is collected as JSON and includes common properties along with API-specific properties in the payload.

`id` String `json:$.id`
`project_id` String `json:$.project_id`,
`session_id` String `json:$.session_id`,
`anonymous_id` String `json:$.anonymous_id`,
`user_id` Nullable(String) `json:$.user_id`,
`address` Nullable(String) `json:$.address`,
`action` LowCardinality(String) `json:$.action`,
`version` LowCardinality(String) `json:$.version`,
`payload` String `json:$.payload`,
`timestamp` DateTime `json:$.timestamp`,

​
User Properties

`project_id` String,
`address` String,
`first_seen` SimpleAggregateFunction(min, DateTime),
`last_seen` SimpleAggregateFunction(max, DateTime),
`first_utm_source` SimpleAggregateFunction(any, String),
`first_utm_medium` SimpleAggregateFunction(any, String),
`first_utm_campaign` SimpleAggregateFunction(any, String),
`first_utm_content` SimpleAggregateFunction(any, String),
`first_utm_term` SimpleAggregateFunction(any, String),
`first_ref` SimpleAggregateFunction(any, String),
`num_sessions` AggregateFunction(uniq, String),
`last_action` SimpleAggregateFunction(anyLast, String),
`last_payload` SimpleAggregateFunction(anyLast, String)

🚧 In development. Additional properties coming soon. 🚧

​
Wallet Profile Properties

🚧 In development. 🚧

Raise issue