Custom Events
Create and manage custom event schemas for off-chain activity tracking
Custom events let you track off-chain user activity — purchases, social actions, game events, signups — and use that data to power incentives.
create_custom_event
Create a custom event schema for tracking off-chain user activity.
Requires: authentication
| Parameter | Type | Required | Description |
|---|---|---|---|
eventName | string | Yes | Unique identifier for the event |
name | string | Yes | Display name |
fields | array | Yes | Field definitions (see below) |
confirmed | boolean | No | Set to true to execute. Omit to preview first. |
Field schema:
| Property | Type | Required | Description |
|---|---|---|---|
fieldName | string | Yes | Field name |
type | "string" | "number" | "boolean" | Yes | Data type |
label | string | No | Display label |
description | string | No | Field description |
userPubkey (wallet address) is always required as a top-level property when sending events — it is not part of the event schema you define here.
list_project_events
List custom events attached to the active project, including events from any project admin. Shows schemas, fields, and query-readiness status.
Requires: authentication, active project
No parameters.
Events must be ingested at least once before they become query-ready for generate_incentive_query.
list_custom_events
List all custom events you've created across all projects. Use this to browse your own events regardless of which project they're attached to.
Requires: authentication
No parameters.
attach_custom_event
Attach an existing custom event to the active project so it can be used in incentives.
Requires: authentication, active project
| Parameter | Type | Required | Description |
|---|---|---|---|
customEventId | string | Yes | ID of the custom event to attach |