For the complete documentation index, see llms.txt. This page is also available as Markdown.

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:product-clicked

Emitted when user clicks on product detail including product list, carousel or pinned highlight.

event.detail

  • product_id - current product id

  • video - current video

Product List

fw:shopping:product-list-item-impression

Emitted for each product in a shopping bag list visible for at least 1 second. event.detail

  • video

  • product

fw:shopping:product-list-item-clicked

Emitted after user clicks on a shopping bag product item.

event.detail

  • video

  • product

Product Card (including pinned highlight)

fw:shopping:product-card-impression

Emitted for each product card visible for at least 1 second.

event.detail

  • video

  • product

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:pinned-product-impression

Emitted when pinned product is visible for 1 second.

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: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

Checkout

fw:shopping:request-checkout

Emitted when use clicks checkout.

event.detail

  • video - current video

  • products - cart conten

Last updated

Was this helpful?