Firework for Developers
One-to-one Virtual ShoppingBusiness Portal
  • Welcome to Firework for Developers
  • Firework Interactive Video and One-to-many Digital Showroom
  • Web
    • Getting Started (Web)
      • Shopify
      • Magento
      • Wordpress (WooCommerce)
      • Salesforce Commerce Cloud
      • BigCommerce
    • Integration Guide for Web
      • Components
        • Hero Unit
        • Carousel / Grid
        • Storyblock (Web)
        • Player (Floating)
        • Storylink
      • Styling
      • Feed Attributes
      • Player
        • Configuration
          • Appearance
      • Video customization
        • Video Factory
        • CTA Button
        • Product cards
      • Events
        • Embed Feed and Storyblock Events
        • Video player events
        • Live stream events
        • Shopping events
      • Shopping Integration (V2)
        • Introduction
        • Shopping APIs
        • Product Hydration
        • Product Factory
        • Cart Sync
        • Tracking
          • Purchase
          • Add to cart
          • Remove from cart
          • Page viewed
        • Shopping Integration FAQ
        • Migrate from V1
      • Web SDK
      • Enhanced Picture-in-Picture
      • Privacy settings
        • Tracking settings
        • Cookies management
        • Content Security Policy
    • Telemetry console
    • Firework Service Domains
    • FAQ & Troubleshooting (Web)
  • Android SDK
    • Integration Guide for Android SDK
      • Getting Started (Android)
      • Video Feed (Android)
        • Video Feed Layouts (Android)
        • Channel Feed (Android)
        • Discover Feed (Android)
        • Playlist Feed (Android)
        • Dynamic Content Feed
        • Channel Hashtags Feed
        • Sku Feed
        • Single Content Feed
        • Configure Video Feed
      • Customization
        • CTA
      • Analytics (Android)
      • Shoppable Videos (Android)
        • Product Hydration
      • Live Stream Support (Android)
      • Video Player (Android)
      • StoryBlock (Android)
      • Share & Video Deep linking
      • Ad Support (Android)
      • Configure Video Advertisements Source (Android)
      • In-app Language Switches
      • Compose support(Android)
    • Sample App (Android)
    • FAQ & Troubleshooting (Android)
    • Changelog (Android)
  • iOS SDK
    • Integration Guide for iOS SDK
      • Getting Started (iOS)
      • ATT compliance (iOS)
      • Video Feed (iOS)
        • Discover Feed(iOS)
        • Channel Feed (iOS)
        • Playlist Feed (iOS)
        • Playlist Group Feed (iOS)
        • Dynamic Content (iOS)
        • Hashtag Playlist (iOS)
        • SKU Playlist (iOS)
        • Video Ads (iOS)
        • Video Feed Layouts (iOS)
      • Story Block (iOS)
      • Customization (iOS)
        • Video feed configurations (iOS)
        • Player configurations (iOS)
        • Shopping configurations (iOS)
          • Customize product card on videos using the custom view (iOS)
        • Customize click behaviors (iOS)
      • Shopping (iOS)
      • Live Stream Support (iOS)
      • Analytics (iOS)
      • Share & Deeplinking(iOS)
      • Ad Support (iOS)
    • Sample App (iOS)
    • FAQ & Troubleshooting (iOS)
    • Changelog (iOS)
  • React Native SDK
    • Integration Guide for React Native SDK V2
      • Getting Started (React Native)
      • ATT compliance React Native (iOS)
      • Video Feed (React Native)
      • Story Block (React Native)
      • Customization (React Native)
        • Video feed configurations (React Native)
        • Player configurations (React Native)
        • Shopping configurations (React Native)
          • Customize product card on videos using the custom view (React Native)
        • Customize click behaviors (React Native)
      • Shopping (React Native)
      • Live Stream Support (React Native)
      • Ad Support (React Native)
      • Analytics (React Native)
      • App-level Language Setting (React Native)
      • Share & Video Deeplinking (React Native)
      • Android Style (React Native)
      • Inject Android Image Loader (React Native)
      • Integrate SDKs in Hybrid React Native and native Apps
      • Reference (React Native)
      • Sample App (React Native)
      • FAQ & Troubleshooting (React Native)
      • Changelog (React Native)
  • Flutter SDK
    • Integration Guide for Flutter SDK V2
      • Getting Started (Flutter)
      • ATT compliance Flutter (iOS)
      • Video Feed (Flutter)
      • Story Block (Flutter)
      • Customization (Flutter)
        • Video feed configurations (Flutter)
        • Player configurations (Flutter)
        • Shopping configurations (Flutter)
          • Customize product card on videos using the custom view (Flutter)
        • Customize click behaviors (Flutter)
      • Live Stream Support (Flutter)
      • Shopping (Flutter)
      • Ad Support (Flutter)
      • Analytics (Flutter)
      • App-level Language Setting (Flutter)
      • Share & Video Deeplinking (Flutter)
      • Inject Android Image Loader (Flutter)
      • Android Style (Flutter)
      • Integrate SDKs in Hybrid Flutter and native Apps
      • Reference (Flutter)
      • Sample App (Flutter)
      • FAQ & Troubleshooting (Flutter)
      • Changelog (Flutter)
  • Help Articles
    • Importing Products to Firework
    • Adding products to a video
    • Displaying product videos on product pages using hashtag filtering(Web)
    • Syncing Carts
    • Encoded IDs
Powered by GitBook
On this page
  • Video events
  • User Interaction events
  • Live Steam events
  • Player events
  • Response

Was this helpful?

  1. Web
  2. Integration Guide for Web
  3. Events

Video player events

Please note most components initiate Video player upon user interaction (e.g. thumbnail click in Embed Feed), some use it directly (Storyblock in autoplay mode)

Video events

Name
Description

fw:video:impression

Dispatched on loaddata video event. Metadata are loaded and player is ready to start the video.

fw:video:start

Video started. Dispatched on first timeupdate video event. Fired for autoplayed thumbnails as well.

fw:video:first-quartile

Video reached 25%.

fw:video:midpoint

Video reached 50%.

fw:video:third-quartile

Video reached 75%.

fw:video:complete

Video reached at least 90%.

fw:video:session

After visitor's engagement with the video is finished. On video end, close or skip to another video.

fw:video:interactable-engaged-view

Dispatched when the the player is full screen or default Storyblock and video has played for 3+ sec.

fw:video:click-cta

When visitor clicks on CTA button (if available).

fw:video:click-share

When user clicks on "Share" button.

fw:video:share

When visitor chooses one of the share options.

These events are universal across our Livestream and short video products. These events are used to track the status of the video.

User Interaction events

These events are universal across our Livestream and short video product and triggered by the user taking an action.

Event Name
Description

fw:video:click-cta

When a visitor clicks on the Call to action (CTA) button

fw:video:click-share

When a user clicks on "Share" button.

fw:video:share

When a visitor chooses one of the share options.

fw:video:submit-answer

When a user submits an answer to the question. Response data contains answer and email if collection is required.

fw:video:submit-choice

When a user submits a choice to the poll. Response contains choice text.

Live Steam events

These are events that are specific to the Live Stream and can be used in conjunction with the above events.

Event Name
Description

fw:livestream:join

A user starts watching the livestream via tap to watch OR start watching with the share link

fw:livestream:quit

A user clicks the "x" or swipes to quit the live stream event

fw:livestream:send-chat

A user sends a chat message

fw:livestream:send-heart

A User clicks heart button

Note fw:livestream:add-to-cart, fw:livestream:checkout and fw:livestream:click-pdp-link are only avaiable for "in-stream" Shopping

Player events

Event Name
Description

fw:player:transition

Player goes to fullscreen/minimized

fw:player:quit

A user quits the player

fw:player:navigate

A user navigates with a link or a button on the player. Can be used to programmatically navigate SPA's in conjunction with pip_navigate=false

Response

Response objects available in event.detail

Name
Description

video

encoded_id - video ID

badge - null | ad | demo | featured

caption - video caption

hashtags - list of hashtag strings

extra

autoplay - true if played as thumbnail, false for full player has_cta - true if CTA action is available

duration - video duration is seconds

progress - current progress in seconds

width - current width of a video element

height - current height of a video element

state - paused | playing_auto | playing_manual (see autoplay)

PreviousEmbed Feed and Storyblock EventsNextLive stream events

Last updated 1 month ago

Was this helpful?