Skip to main content
Use Bily’s title-case event names for product and order activity. The SDK recognizes them and maps typed products and orders to the Bily event contract.

Record a product view

quantity defaults to 1 when omitted.

Record an add to cart

Record the start of checkout

Record a completed order

Use order when an event represents one order. If you provide order.total, the SDK uses it. Otherwise, it calculates the total from product price and quantity.
Totals, tax, discounts, and shipping fees can all be zero.

Use an exact event name

  • Product List Viewed
  • Products Searched
  • Product Clicked
  • Product Added
  • Product Added to Wishlist
  • Product Removed
  • Product Removed From Cart
  • Product Removed From Wishlist
  • Product Viewed
  • Cart Viewed
  • Checkout Started
  • Checkout Step Viewed
  • Checkout Step Completed
  • Payment Info Entered
  • Shipping Info Entered
  • AddShippingInfo
  • AddContactInfo
  • Checkout Address Info Submitted
  • Order Completed
  • Order Updated
  • Order Refunded
  • Order Cancelled
  • Clicked Promotion
  • Viewed Promotion
  • ViewCategory
Match the spelling and capitalization exactly. See event names for accepted legacy aliases.

Include every required product field

Every product needs id, name, price, and currency. Include quantity, sku, category, brand, and image when you have them.

Payload reference

See every field in BilyProduct and BilyOrder.