All docs

Custom events

Last updated 29 October 2026 · 1 minute read

A custom event is a name and, optionally, a few properties. Send one with track("name", { ... }) from the script or the SDK, then find it in Events and use it as a funnel step.

Sending an event

window.eventfox.track("checkout_started", { plan: "team", seats: 5 });

With the npm package:

import { track } from "@eventfox/web";

track("checkout_started", { plan: "team", seats: 5 });

Rules

  • Names are 1 to 200 characters. Names starting with $ are reserved; $pageview is the page view.
  • Properties can be strings, numbers, booleans, null, arrays of those, or one level of nested object. There can be up to 50 keys, key names up to 100 characters, and string values up to 1,000 characters.
  • Events that break the rules are dropped and counted as rejected; the rest of the batch is still stored.

What Eventfox removes

Anything your project's privacy settings block is removed on the server before it is stored, whatever the script sent.

  • Property names such as email, phone, password, token and postcode are blocked by default. You can change the list in Settings → Privacy.
  • Anything that looks like an email address in a page path or a property value can be replaced with [email]. This is on by default.
  • Query strings are never stored, apart from the three UTM values.

Finding your events

The Events page lists them as they arrive. Filter by event name or by a property. The Overview's "Top events" list counts each name.