Custom events - Videowise

Live shopping events are dispatched on window. Use window.addEventListener to intercept them. These events are for live shopping. Widget events are documented separately — see Shoppable video custom events. On React Native, live events arrive through onEvent on LiveShoppingChannel — see Live Shopping Channel.

Code Block Example

window.addEventListener("videowiseLiveOnInteraction", (event) => {
  console.log(event.detail.interactionType); // for example mute_player
  console.log(event.detail); // return Data from event
});

customCart

Set customCart: true on window.videowiseInfo when the storefront owns add-to-cart (headless Shopify, custom cart drawer, Hydrogen, and so on). When customCart is true, a Shop Now click in the live player:

Does not call Shopify /cart/add.js (no Videowise Ajax cart, no in-player cart).
Minimizes the player.
Always dispatches videowiseProductAddToCart on the parent storefront (the player iframe posts it to the host page).
Does not dispatch videowiseLiveOnInteraction with interactionType = add_to_cart — that interaction is only fired from Shopify Ajax add.

The in-player virtual cart never opens when customCart is true. Cart icon taps still show, but they only dispatch videowiseLiveOnInteraction with interactionType = show_cart — open your own cart UI from that event. hide_cart is not sent (there is no in-player cart to close). You must listen for videowiseProductAddToCart on the parent page and add the item with your own cart logic. If you do not, nothing is added to the cart. Do not wait for add_to_cart on videowiseLiveOnInteraction.

<script>
  window.videowiseInfo = {
    shop: 'your-store.myshopify.com',
    cartType: 'shopify',
    currency: 'USD',
    customCart: true,
  };

  window.addEventListener('videowiseProductAddToCart', (event) => {
    const { variantId, qty, productId, productName, price, currencyCode, selectedVariant, subscriptionId } =
      event.detail || {};

    if (variantId && qty) {
      addToCart(variantId, qty);
      openCartDrawer();
    }
  });

  window.addEventListener('videowiseLiveOnInteraction', (event) => {
    if (event.detail?.interactionType === 'show_cart') {
      openCartDrawer();
    }
  });
</script>

For videowiseProductAddToCart, event.detail includes productName, productId, variantId, qty, price, currencyCode, deviceType, url, subscriptionId, and selectedVariant. When customCart is omitted or false, live shopping still adds via Shopify Ajax, fires videowiseLiveOnInteraction with add_to_cart, and still fires videowiseProductAddToCart (for tracking or extra UI). The custom event is required for cart only when customCart is true. This is separate from shoppable widget add-to-cart (Buy button → Virtual cart). Widgets use that dashboard setting; live shopping uses videowiseInfo.customCart. See Shoppable video custom events.

Events

videowiseLiveOnPlay

Triggered when the live stream is playing.

clientTS
currentTime
device
eventType
interactionType = resume_player
isLive
lsId
organisationId
siteId
uid
url
videoElapsedMinutes
videoElapsedSeconds

videowiseLiveOnStop

Triggered when the live stream is closed.

clientTS
currentTime
device
eventType
interactionType = close_player
isLive
lsId
organisationId
siteId
uid
url
videoElapsedMinutes
videoElapsedSeconds

videowiseLiveOnInteraction

Triggered when a user executes a specific interaction during the live stream.

clientTS
currentTime
device
eventType
interactionType
isLive
lsId
organisationId
siteId
uid
url
videoElapsedMinutes
videoElapsedSeconds

The interactonType can be:

mute_player
unmute_player
pause_player
resume_player
like_reaction
share
add_to_calendar
send_chat
minimize_player
maximize_player
show_product_list
hide_product_list
product_click
add_to_cart — only when customCart is not set. With customCart: true this interaction is not dispatched; use videowiseProductAddToCart instead.
checkout
show_cart — cart icon tap. With customCart: true this is how you open your cart (the in-player virtual cart does not open). Without customCart, this fires when the in-player cart opens.
hide_cart — in-player cart closed. Not sent when customCart is true.
replay
progress

If interactionType = share then the event will contain in addition:

socialShare

If interactionType = product_click | add_to_cart then the event will contain in addition:

item (which is data about product from the live stream)

add_to_cart is emitted from Shopify Ajax add (handleAddToCart). When window.videowiseInfo.customCart is true, that path is skipped, so videowiseLiveOnInteraction will not have interactionType = add_to_cart.

videowiseLiveStreamingPlayerInit

Triggered when the live streaming player is initialized.

videowiseProductAddToCart

Dispatched on the parent storefront when the shopper clicks Shop Now in the live player (the iframe posts the event to the host page). Listen on the parent window, not inside the player iframe. event.detail:

productName
productId
variantId
qty
price
currencyCode
deviceType
url
subscriptionId
selectedVariant

When window.videowiseInfo.customCart is true, this event is the only add-to-cart signal. The player does not call Shopify /cart/add.js, does not open the in-player virtual cart, minimizes after the click, and does not dispatch videowiseLiveOnInteraction with interactionType = add_to_cart. Cart icon taps dispatch show_cart instead — open your own cart from that interaction. If you do not handle videowiseProductAddToCart, the item is not added.

When customCart is omitted or false, Shopify Ajax add still runs, videowiseLiveOnInteraction still includes add_to_cart, and videowiseProductAddToCart still fires (for tracking or extra UI).

window.addEventListener('videowiseProductAddToCart', (event) => {
  const { variantId, qty, productId, price, currencyCode, selectedVariant, subscriptionId } =
    event.detail || {};

  if (variantId && qty) {
    addToCart(variantId, qty);
  }
});

This is the same event name as shoppable widgets. For live shopping with a custom cart, set customCart: true — see customCart.

​customCart

​Events

​videowiseLiveOnPlay

​videowiseLiveOnStop

​videowiseLiveOnInteraction

​videowiseLiveStreamingPlayerInit

​videowiseProductAddToCart

​Related

customCart

Events

videowiseLiveOnPlay

videowiseLiveOnStop

videowiseLiveOnInteraction

videowiseLiveStreamingPlayerInit

videowiseProductAddToCart

Related