Custom events

Record any custom events in your app, along with properties that describe the action. Custom events can capture a broad range of actions, such as starting a swap or completing a deposit. Additional information about the event can be included in the properties field. For example, for a Swap Completed event, you may want to include the token pair, input amount, and output amount.

Naming events

When naming events, Formo recommends establishing a consistent naming convention that uses:

Consistent formatting: Event names are case sensitive.
A consistent syntax: Adopt nouns and past tense verbs like Swap Completed and Deposit Submitted. A standard of [Noun] + [Past-Tense Verb] ensures all your events are consistent.
A consistent actor: Does Transaction Submitted mean that the user submitted a transaction or that your app submitted it on their behalf? If all your events are named in a way that reflects the user’s perspective, the meaning is clear immediately.

This allows everyone including you 6 months from now to instantly understand the meaning of an event.

Properties

Properties are additional information that give more clarity of your users’ actions. Every custom event has type set to track and event set to your custom event name, with the event-specific data passed in the properties object:

{
  "type": "track",
  "event": "Swap Completed",
  "properties": {
    "pair": "ETH/USDC",
    "token_in": "ETH",
    "token_out": "USDC"
  }
}

Formo has reserved some standard properties listed in the following table and handles them in a special manner.

Tracking volume, revenue, points

You can track volume, revenue, and points in your events. Once tracked, they are shown on the dashboard. Include these optional properties in a custom event to track values associated with an action.

Property	Type	Description
`volume`	Number	The volume amount as a result of an event. For e.g., a token swap worth $20.00 would result in a volume of 20.00. Can be positive or negative e.g. send -100 to track outflows.
`revenue`	Number	The revenue amount as a result of an event. For e.g., a transaction with a protocol fee of $5.00 would result in a revenue of 5.00. Must be a non-negative number.
`currency`	String	The currency of the revenue as a result of the event, set in ISO 4217 format. If this is not set, Formo assumes the revenue is in USD.
`points`	Number	An abstract value such as points or XP associated with an event, to be used by various teams.

For example, call .track() with the reserved properties alongside any other event properties:

analytics.track('Swap Completed', {
  pair: 'ETH/USDC',
  token_in: 'ETH',
  token_out: 'USDC',
  amount_in: 1.5,
  amount_out: 4500,
  volume: 4500,
  revenue: 13.5,
  points: 50
});

Sample Payload

{
  "type": "track",
  "event": "Swap Completed",
  "properties": {
    "pair": "ETH/USDC",
    "token_in": "ETH",
    "token_out": "USDC",
    "amount_in": 1.5,
    "amount_out": 4500,
    "volume": 4500,
    "revenue": 13.5,
    "points": 50
  }
}

Methodology

Data

Data Warehouse

Naming events

Properties

Tracking volume, revenue, points

Sample Payload

​Naming events

​Properties

​Tracking volume, revenue, points

​Sample Payload

Naming events

Properties

Tracking volume, revenue, points

Sample Payload