Event names

BilyEvent autocompletes known events and still accepts your own event names.

type BilyEvent = KnownBilyEvent | (string & Record<never, never>);

Event names are case-sensitive. Use the capitalization shown for Bily events. Create a stable snake_case application event only when no standard event describes the outcome.

Use known Bily events

type KnownBilyEvent =
  | "AddContactInfo"
  | "AddShippingInfo"
  | "Checkout Address Info Submitted"
  | "Contact"
  | "Contact Submitted"
  | "Demo Requested"
  | "Download"
  | "New Customer Purchase"
  | "PageView"
  | "Pageview"
  | "Product Removed From Cart"
  | "Product Removed From Wishlist"
  | "ViewCategory"
  | "Product List Viewed"
  | "Products Searched"
  | "Product Clicked"
  | "Product Added"
  | "Product Added to Wishlist"
  | "Product Removed"
  | "Product Viewed"
  | "Checkout Step Viewed"
  | "Checkout Step Completed"
  | "Shipping Info Entered"
  | "Order Refunded"
  | "Clicked Promotion"
  | "Viewed Promotion"
  | "Category Viewed"
  | "Checkout Started"
  | "Payment Info Entered"
  | "Payment Add Contact Info"
  | "Payment Add Shipping Info"
  | "Payment Add Address Info"
  | "Subscription"
  | "New Customer Order"
  | "New Customer Subscription"
  | "Order Completed"
  | "Cart Viewed"
  | "Remove from Cart"
  | "Cart Updated"
  | "Order Updated"
  | "Order Cancelled"
  | "Lead"
  | "Login"
  | "Logout"
  | "Search"
  | "Sign Up"
  | "Add to Wishlist"
  | "Remove from Wishlist"
  | "View Wishlist"
  | "Newsletter"
  | "Contact Form Submitted"
  | "Subscription Cancelled"
  | "Subscription Started"
  | "Subscription Updated"
  | "Subscription Renewed"
  | "Trial Started";

Prefer standard application outcomes

Use the same standard name whether Bily found the action on a public page or you install it in application code.

Verified outcome	Event
Authentication succeeded	`Login`
Registration succeeded	`Sign Up`
Contact request submitted	`Contact Submitted`
Demo or sales meeting scheduled	`Demo Requested`
Trial started	`Trial Started`
Subscription started	`Subscription Started`
High-intent step that is not yet a completion	`Lead`
Download completed	`Download`

Do not emit a completion event from the button that merely begins the flow. Track it at the successful callback or committed state.

Use current ecommerce names

For new ecommerce tracking, use the current names in the ecommerce guide. The SDK still accepts these compatibility names and converts them before delivery:

Compatibility name	Current name
`Pageview`	`PageView`
`Add to Wishlist`	`Product Added to Wishlist`
`Category Viewed`	`ViewCategory`
`Contact Form Submitted`	`Contact`
`New Customer Order`	`New Customer Purchase`
`Payment Add Address Info`	`Checkout Address Info Submitted`
`Payment Add Contact Info`	`AddContactInfo`
`Payment Add Shipping Info`	`AddShippingInfo`
`Product Added To Wishlist`	`Product Added to Wishlist`
`Remove from Cart`	`Product Removed From Cart`
`Remove from Wishlist`	`Product Removed From Wishlist`
`Search`	`Products Searched`

Add product-specific application events

track("workspace_created", {
  workspace_id: "workspace_456",
});

Every custom name must contain at least one non-whitespace character. Keep a short internal event catalog so every component uses the same spelling.

Track custom events

Create stable names and safe properties for your application.

Reference

Methods

Types

Use known Bily events

Prefer standard application outcomes

Use current ecommerce names

Add product-specific application events

Track custom events

​Use known Bily events

​Prefer standard application outcomes

​Use current ecommerce names

​Add product-specific application events

Track custom events

Use known Bily events

Prefer standard application outcomes

Use current ecommerce names

Add product-specific application events