Magento 2 integration technical manual [plugin]


To connect your Magento 2 webshop with MailBlue, there is a plugin available for Magento. Through this integration, orders from your Magento webshop will be received in MailBlue, and you can automatically follow up on them. Additionally, abandoned cart emails can be sent from MailBlue using the plugin.

This guide explains how to install and set up this plugin. To install it, you need access to the CLI / SSH / Terminal of the server where Magento is installed.

NOTE: This is a technical guide, please have your website developer perform these steps.

System requirements

  • PHP 7.4/8
  • Magento 2.3/2.4
  • Elastic Search 7

Downloading the plugin

Installing the plugin

The plugin consists of different modules. Execute the following command to install and activate all modules.

php bin/magento module:enable ActiveCampaign_Core ActiveCampaign_Customer ActiveCampaign_AbandonedCart ActiveCampaign_Order ActiveCampaign_SyncLog

After activating the modules, you need to recompile and deploy Magento. You can do this using the following commands:

php bin/magento setup:upgrade 
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy


Configuring the plugin

To configure the plugin, you will need the API credentials from your MailBlue account. For more information on where to find these credentials, click here. You will need these credentials for the following steps:

  • In your Magento installation, go to Stores -> Configuration
  • In the left menu, click on ActiveCampaign -> Configuration
  • Update the following details:
    • Status: Enabled
    • API URL: [URL from your MailBlue account ( or]
    • API Key: [API key from your MailBlue account]
  • Click on 'Connect'
    • If you encounter an error message here, double-check the details.
  • If everything is successful, you will receive a notification to refresh the Magento cache, click on the link and reset the invalid caches.

Synchronising orders, customers, abandoned carts 
Under the API settings, you can customise how data is transferred to MailBlue.

Order sync configuration
Here you can specify how orders will be forwarded to MailBlue. If you have a busy store, it is recommended to run the cron job more frequently. By default, it is set to run every fifth minute of the hour.

You can also indicate here whether orders should be forwarded immediately after placement. If this is enabled, the cron job will not apply.

Abandoned Cart
With abandoned carts, you can create a follow-up within MailBlue to encourage the customer to complete the order. These are stored in Magento and forwarded to MailBlue. By default, this occurs every hour, on the hour. If your webshop is busier, it is advisable to adjust this setting to run more frequently.

Within Magneto, old abandoned shopping carts can also be stored. There is a possibility to synchronise these. Please be aware that this data may not be 100% accurate as it involves historical data.

Synchronising customers is a basic requirement that should always be enabled. Without customer synchronisation, orders cannot be processed. You can adjust how often customers are synchronised. By default, this is set to once per hour, on the tenth minute of the hour. For busier webshops, we recommend running this more frequently.

Sync Log Settings
Are you experiencing issues with data synchronisation? In that case, we recommend enabling the 'Sync log'. Please note: always do this in Debug mode. This will provide detailed logging of the actions being performed. The log is stored at /var/log/activecampaign.log. If you have "SyncLog Delete" enabled, the log will be automatically cleared after 7 days. This ensures that unnecessary logging is not retained.

Historical orders sync
The plugin does not have the ability to synchronise previously placed orders in bulk. The only way to get these orders into your MailBlue account is to do so by going to Orders, selecting the desired orders, and choosing 'Send to ActiveCampaign' under Actions.

Was this article helpful?
0 out of 0 found this helpful