Magento Storefront Event Collector

Overview

This package listens for and handles events sent from the Magento Storefront Events SDK. It runs as a side effect and is meant to be a convenience for users who want to send events to Magento for processing.

Installation

The collector can be used as a hosted script, or bundled in a JavaScript application. The script version is hosted on unpkg, and the bundled version is hosted on npm.

To load the SDK as a script, use the following snippet.

<script src="https://unpkg.com/@adobe/magento-storefront-event-collector/dist/index.js"></script>

To install the script as a dependency, run this command.

npm install @adobe/magento-storefront-event-collector

Quick Start

After loading the collector script, or importing the package as shown below, there is nothing else that needs to be done.

import "@adobe/magento-storefront-event-collector";

The collector then begins listening for the following events.

• addToCart
• instantPurchase
• pageView
• placeOrder
• productPageView
• recsItemAddToCartClick
• recsItemClick
• recsRequestSent
• recsResponseReceived
• recsUnitRender
• recsUnitView
• searchCategoryClick
• searchProductClick
• searchRequestSent
• searchResponseReceived
• searchResultsView
• searchSuggestionClick
• shoppingCartView

The handlers forward events to two edges:

• Adobe Commerce Data Services (maintained by Adobe Engineering and used to power merchant performance dashboards)

  Required contexts:

  StorefrontInstance

• Adobe Experience Platform (requires a subscription and additional merchant setup; data can be used by merchants inside the Adobe Experience Platform for detailed analytics, targeted merchandising, real time customer data profiles, and more)

  Required contexts:

  AEP

  EventForwarding.aep: true

Support

If you have any questions or encounter any issues, please reach out at these locations.

• GitHub