Learn how to install our Firework extension and configure this within your Adobe Commerce Cloud.
Before continuing, ensure your configuration is set to Adobe Commerce Cloud.
Estimated time to set up::
- 15 - 20 mins with an existing Magento and Firework account.
- Requires developer work to install codebase.
- Debug/Testing in environment = varies based on developer team.
- App set up and install.
Estimated time to import products:
- Times vary based on # of items being imported.
Note: These are estimates after reviewing the below steps. If you see yourself running into hurdles, then please reach out for assistance!
Install the Firework Extension in Magento
- Navigate to the Magento Marketplace (My Profile - Access Keys) copy your access key, and paste it into the
auth.json
file in your Magento project. - Use the "composer require firework/firework" command to add the extension to your project.
- Please run the following commands to install codebase and database schemas:
php bin/magento setup:di:compile
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy -f
php bin/magento indexer:reindex
php bin/magento cache:clean
php bin/magento cache:flush
- Please run the following commands to install codebase and database schemas:
- Exit the command line interface and open your Administrator console for Magento 2.
- Navigate to the Store and then Configuration. If there is a new tab in the menu with the Firework Logo, it means you’ve installed the Firework extension correctly!
NOTE: Do not modify the Endpoint URL in Webhook Configuration, it will be prefilled and modifying it will break the integration.
To implement all changes on the storefront, the store admin needs to flush the cache each time settings and configurations are done.
Feel free to reach out to your Firework Account Manager if you need any assistance with the above!
Configure the Firework Extension
Once the Firework Extension is installed, we need to ensure it is configured correctly to integrate with your stores. These steps need to be performed by a Magento store administrator.
-
Navigate to
Stores -> Integrations
. -
Click Add New Integration.
-
Fill in the required details:
-
Name: e.g., “Firework”
-
Email: Representative user’s email (any email is fine)
-
Your Password: Login password
-
Leave Callback URL and Identity Link URL blank
-
-
Select API and allow access to:
-
Cart
-
Catalog
-
Customers
-
Marketing
-
My Account
-
Embed Firework Widget into Pages
Pattern 1: Using Widget Insert
-
Go to
Content -> Pages
. -
Select Edit on the page you want.
-
Choose Edit with Page Builder.
-
Add an HTML Code block where you want to embed the widget.
-
Click Edit (⚙).
-
Select Insert Widget and choose Firework Videos.
-
Choose layout, channel, and playlist, then click Save.
Pattern 2: Using HTML Code
-
Get HTML code from Firework Dashboard → Playlist/Layout.
-
Paste and edit the HTML code in the content section.
Use Pattern 1 for simple embed without coding (limited customization).
Use Pattern 2 to customize layout, size, titles, etc. (requires HTML knowledge). -
If you would like to implement Product/Cart Hydration you will need to add the following script -
<script async type="text/javascript" src="//asset.fwcdn3.com/js/integrations/magento.js"></script>
Show Multiple Playlists Avoid script duplication by using only fwn.js
, which includes logic from storyblock.js
and embed-feed.js
.
Sync Product Info with Firework
-
Go to
Firework -> Firework Dashboard
. -
Select the store.
-
Click Import Products.
-
Select products to import.
-
Products will appear under the product tab.
-
Go to
Stores -> Configuration -> Firework
and enable Purchases Tracking.