Magento Web
Install the Magento Storefront Module
The Magento Website Integration consists of a Magento module that tracks your storefront and checkout events.
Installation Instructions
The Converge Website installation for a Magento store consists of:
Create a new Client Source in Converge
- In Converge, click on Create a new source
- Pick Client-side from the modal
- Name your pixel: e.g.
{Storename} Storefront
Install the Magento Plugin
-
Add the Converge repository to your Magento 2 project’s
composer.json
file:bashcomposer config repositories.repo-name vcs https://github.com/run-converge/converge-magento2
-
Run the following command to install the Converge Magento 2 module:
bashcomposer require run-converge/converge-magento2:0.1.4
-
Enable the Converge module using the Magento CLI:
bashbin/magento module:enable Converge_Converge
-
Upgrade your Magento setup to ensure the Converge module is integrated properly:
bashbin/magento setup:upgrade
-
Deploy static content to your Magento store for the Converge module:
bashbin/magento setup:static-content:deploy
Configure the Converge Magento Plugin with your public token
- In the Converge web app, click on the source you created in Step 1 and copy the Public Token. The code consists of 6 characters and can be retrieved from the HTML snippet. If your script
src
looks likehttps://static.runconverge.com/pixels/AYU51m.js
, then your public token isAYU51m
. - Go to
Stores
>Settings
>Configuration
>Converge
>Converge
and add the public token you just retrieved.
Verify that the integration is working correctly
- Check that the plugin is working correctly by generating some
$page_load
,Added To Cart
, andStarted Checkout
events by visiting the store and seeing that these events arrive in the Source Log.
Event Spec
This integration auto-tracks the following events on the browser with all properties available according to the Converge Event Spec.
Event Name | Event Description | Integration |
---|---|---|
PageView | When a customer views a page. | Storefront |
Viewed Product | When a customer views a product. | Storefront |
Added To Cart | When a customer adds an item to cart | Checkout |
Started Checkout | When a customer initiates the checkout process. | Checkout |