Skip to main content
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. Use stable snake_case names for application events.

Use known Bily events

type KnownBilyEvent =
  | "AddContactInfo"
  | "AddShippingInfo"
  | "Checkout Address Info Submitted"
  | "Contact"
  | "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"
  | "Add to Wishlist"
  | "Remove from Wishlist"
  | "View Wishlist"
  | "Newsletter"
  | "Contact Form Submitted"
  | "Subscription Cancelled"
  | "Subscription Updated"
  | "Subscription Renewed";

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 nameCurrent name
PageviewPageView
Add to WishlistProduct Added to Wishlist
Category ViewedViewCategory
Contact Form SubmittedContact
New Customer OrderNew Customer Purchase
Payment Add Address InfoCheckout Address Info Submitted
Payment Add Contact InfoAddContactInfo
Payment Add Shipping InfoAddShippingInfo
Product Added To WishlistProduct Added to Wishlist
Remove from CartProduct Removed From Cart
Remove from WishlistProduct Removed From Wishlist
SearchProducts Searched

Add 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.