➡️Custom Events

You can track custom events across your application to gain a more detailed understanding of how users interact with it.

Track

After you initial the Spindl SDK, you can call track on any interactions you want to track:

NPM SDK

import spindl from "@spindl-xyz/attribution";
// import spindl from "@spindl-xyz/attribution-lite" // only for lite version customers

// Track a basic event
spindl.track('form_submitted');

// Track events with optional properties
const additionalProperties = {
  value: 55,
  filterSelected: true,
  color: "red"
};

// optionally add user identity properties 
const identityProperties = {
  address: "0x1234...",
  customerUserId: "[email protected]"
};

spindl.track('button_clicked', additionalProperties, identityProperties);

HTML Script SDK

<script>
// Track a basic event
window.spindl.track('form_submitted');

// Track events with optional properties
const additionalProperties = {
  value: 55,
  filterSelected: true,
  color: "red"
};

// optionally add user identity properties 
const identityProperties = {
  address: "0x1234...",
  customerUserId: "[email protected]"
};

window.spindl.track('button_clicked', additionalProperties, identityProperties);

</script>

SDK Method

To make data easily queryable, we have put the following restrictions on properties:

spindl.track(
    event_name: string,
    event_properties?: Record<string, any>,
    identity_props?: {
        address?: string;
        customerUserId?: string;
    }
): void

Arguments

• event_name (required): Min 3 & max 100 characters. Must be lower/uppercase alphanumeric. _:- symbols are allowed

• event_properties (optional): Must be a valid JSON object. Max size 16KB & object keys & values cannot exceed 1,000 characters

• identity_props (optional): You can pass in user props address and customerUserId to improve identity matching