Links

Shopping events

Description of custom events related to shopping experience either in short videos or during livestream. Shopping events can be used to integrate with Firework into your e-commerce platform.

Shopping

Name
Description
fw:shopping:request-checkout
Emitted when use clicks checkout.
event.detail
  • video - current video
  • products - cart content
fw:shopping:product-card-clicked
Emitted when a click happens on product cards (video overlay), only applicable to short video or trailer.
event.detail
  • product_id - current product id
  • video - current video
fw:shopping:product-clicked
Emitted when user clicks on product detail which should lead to merchant's product detail page. (will be updated later to only emit when a click happens on a product in a product list)
event.detail
  • product_id - current product id
  • video - current video
fw:shopping:pdp-primary-cta-clicked
Emitted when a click happen on the primary CTA on product details.
event.detail
  • product - current product
  • product_unit - current unit
  • video - current video
  • type
    • BUY NOW: Instant checkout buy now button
    • SHOP NOW: A viewer will be redirected to off player PDP on click.
    • ADD TO CART: Add to cart button
fw:shopping:pinned-product-clicked
Emitted when a click happen on pinned product (product highlight)
event.detail
  • product_id - current pinned product id
  • video - current video
fw:shopping:clickshoppay
Emitted when user clicks on ShopPay button
  • video - current video
  • extra
    • url - url of the Shopify product page
fw:shopping:click-buy
Emitted when user clicks on the Buy button on product modal
  • video - current video
  • product - product
  • product_unit - product variant
  • quantity - quantity selected by customer
fw:shopping:click-calculate-total
Emitted when user clicks on Done button after filling out their information
  • video - current video
  • cart - cart content
fw:shopping:click-place-order
Emitted when user clicks on Place Order button
  • video - current video
  • cart - cart content