Adobe Commerce (formerly Magento) - e-commerce

If you run an e-commerce store on Adobe Commerce (formerly Magento), you can use the Blueshift extension to send customer, product, and order data from your store to Blueshift. Once connected, you can use this data to build segments, run campaigns, and personalize customer experiences.

Events collected by the extension

The extension collects events from your Adobe Commerce store and sends them to Blueshift. Events fall into two categories: those captured via JavaScript inserted at setup and those captured via Adobe Commerce events.

Events captured through JavaScript

Login activities — Login, Logout
Views — Page views, Product views

Events captured through Adobe Commerce events

Cart activities — Cart create, Cart update, Checkout create
Order activities — Order create, Order cancel, Fulfillment create, Fulfillment update, Refund create
Customer activities — Customer create, Customer update, Customer delete, Customer enable, Customer disable
Product activities — Product create, Product update, Product delete

Prerequisites

Before you set up the integration, deploy the Blueshift extension into your Adobe Commerce store.

Deploy the Blueshift extension

Sign in to the Adobe Commerce Marketplace.
Search for the Blueshift Connect extension, or go directly to the extension page.
Select your store's version and click Add to Cart.
Open the cart and click Proceed to Checkout.
On the Checkout page, click Place Order.
Click Install on the confirmation page. You will be taken to the access keys page.

Make sure your access keys are added to your store. For details, see the System Configuration documentation.
Sign in to your Adobe Commerce store admin.
In the left navigation panel, click System > Web Setup Wizard.
On the Setup Wizard page, click Extension Manager.
Click Review and Install under Extensions Ready to Install.
On the Ready to Install page, click Install next to blueshift/blueshiftconnect.
On Step 1: Readiness Check, click Start Readiness Check. When the check completes, click Next.
On Step 2: Create Backup, either click Create Backup or uncheck all options and click Next.
Wait for the extension to install. A confirmation message appears when the installation succeeds.

Troubleshoot installation issues

If the extension does not install successfully, run these commands on your server:

Sign in to the server running Adobe Commerce.
Change directory to the Adobe Commerce installation location (for example, /var/www/html/magento).

Run the upgrade and compile commands:

sudo php bin/magento setup:upgrade
sudo php bin/magento setup:di:compile

Set permissions on the required directories:

sudo chmod -R 777 var/ generated/
sudo chmod -R 777 pub

Clear and flush the cache:

php bin/magento cache:clean
php bin/magento cache:flush

After running these commands, sign back in to the Adobe Commerce admin and verify that Blueshift appears under Stores.

Set up the integration

After the extension is installed, configure it with your Blueshift API keys and synchronization preferences.

Configure extension credentials

In the Adobe Commerce admin, go to Stores > Configuration > Blueshift > Blueshift Connect.

Expand the Extension Credentials section and enter the following details:

Field	Description
API URL	Defaults to `https://api.getblueshift.com/api/v1/`. Change this only if instructed by Blueshift Support.
User API Key	Your Blueshift User API Key. Find it under Account Settings > API Keys in your Blueshift account.
Event API Key	Your Blueshift Event API Key. Find it under Account Settings > API Keys in your Blueshift account.
Installation ID	A unique identifier for this Adobe Commerce installation.
Add Installation ID Prefix to Entity IDs	When set to Yes, entity IDs (customer, product, order) are prefixed with the Installation ID. For example, customer `100` is sent as `12345_100`. When set to No, only the entity ID is sent (for example, `100`). Use this when the same entity IDs may exist across multiple Adobe Commerce installations.

Click Save Config.

Configure synchronization and catalog

Expand the Synchronization Data and Catalog section and enter the following details:

Field	Description
From	Select the date from which to synchronize your store's data with Blueshift. You can choose a date as early as your store's creation date. The extension fetches historical data for customers, products, and orders from this date.
Unsubscribe Data	Select Yes to add unsubscribe information from Blueshift back to the customer's profile in Adobe Commerce. Select No to keep unsubscribe data in Blueshift only.
Catalog Name	Select a Blueshift catalog to receive products from this Adobe Commerce store. To create a new catalog, use the New Catalog option below.
New Catalog	Click Or Create a Catalog to enable this field, then enter a name for the new catalog.

Click Save Config.
In the Status section, click Start Synchronization to begin sending data to Blueshift.

Multi-store configuration (Optional)

By default, all your Adobe Commerce stores share the same Blueshift settings. If you want to send data from different stores to separate Blueshift accounts, you can customize the API keys for each store individually.

Use the Scope dropdown at the top-left to select the specific store you want to configure.
Locate the field you want to change, such as the User API Key.
Uncheck the Use Default or Use Website box next to the field to unlock it.
Enter your new value and click Save Config.

Adobe Commerce (formerly Magento) - e-commerce

Comments