Quick start: Configuration guide - Magento 2


This comprehensive guide provides start to finish instructions for users who are attempting to install and configure the connector for the first time.  It focuses on the most important things you need to know, and do, in order to get going.

This guide doesn't cover advanced features. Full and comprehensive guidance can be found at Engagement Cloud for Magento 2.

Pre-Installation Health Check


The Engagement Cloud for Magento connector is compatible with both Community and Enterprise platforms of Magento.

  • For Community we're compatible with 2.2 +
  • For Enterprise we're compatible with 2.2 +


While every site is different, the connector could potentially come into conflict with other extensions. For example, abandon cart extensions and other SMTP tools could also possibly come into conflict with the connector, and this makes it important to state these during the installation process.

File Permissions

  • Requires full access (0777) to the var/export directory or full access to the CRON user running on the server.

Cron Tasks

The connector has several cron tasks attached with the install to ensure the connector functions correctly. Below is a list of current tasks and their timings:

  • ddg_automation_abandonedcarts - 5 minute intervals
  • ddg_automation_campaign - 5 minute intervals
  • ddg_automation_catalog_sync -15 minute intervals
  • ddg_automation_cleaner – 1st of every month
  • ddg_automation_customer_subscriber_guest_sync - 15 minute intervals
  • ddg_automation_importer – 5 minute intervals
  • ddg_automation_order_and_quote_sync - 15 minute intervals
  • ddg_automation_reviews_and_wishlist - 15 minute intervals
  • ddg_automation_status -15 minute intervals

The cron heartbeat should be running every minute to action the required tasks.

Have Multiple Websites?

The connector supports multiple websites.  If there are multiple sites within the same Magento instance then we recommend you link one site to one Engagement Cloud account.  If you are configuring multiple sites to multiple Engagement Cloud accounts, you will need to follow the entire process for each separate Engagement Cloud account you have.


The installation of the Magento 2 connector can be done via FTP or Composer. If you are on a version of Magento 2.2.2 + the connector is already bundled into Magento and no installation is required.


  1. Download the files to the connector from GitHub located at  https://github.com/dotmailer/dotmailer-magento2-extension
  2. Download it as a ZIP and unzip the file.
  3. Create the directory structure in Magento ('Magento_Root/app/code/Dotdigitalgroup/Email‘).
  4. Drop all content inside the unzipped folder to directory ('Magento_Root/app/code/Dotdigitalgroup/Email‘).
  5. Run the command 'php bin/magento module:enable Dotdigitalgroup_Email' in Magento root.
  6. Run the command 'php bin/magento setup:upgrade' in Magento root.
  7. Run the command 'php bin/magento setup:di:compile' if you have a single website and store or run 'php bin/magento setup:di:compile-multi-tenant' if you have multiple.
  8. Clear cache from Magento admin.


  1. Set up the correct path for Composer or keep Composer within Magento root.
  2. In Magento root, run command 'composer require dotmailer/dotmailer-magento2-extension'.
  3. After the above is successful, run the command 'php bin/magento module:enable Dotdigitalgroup_Email' in Magento root. This will let Magento know about the module.
  4. Run the command 'php bin/magento setup:upgrade' in Magento root. This will ensure any installer scripts we may have are executed properly and store the current data version.
  5. Run the command 'php bin/magento setup:di:compile' if you have a single website and store.
  6. Run 'php bin/magento setup:di:compile-multi-tenant' if you have multiple.
    Clear cache from Magento admin.

Bundle (Magento 2.2.2 +)

The bundled version comes stock with version 2.3.8 of the connector.  There is a few different scenarios on how to properly setup and upgrade the connector. Each scenario is documented in detail in our 'Upgrading to Magento 2.2.2' article located here.  It is highly recommend to review the 'Upgrading to Magento 2.2.2' article prior to doing any work with the connector.

Enterprise Edition?

Additional files are required to syncrhonise certain types of data found in Enterprise versions of Magento such as Reward Points and Customer Segments. The files can be found on GitHub here and should be added after the standard connector has been installed.


Create API User

To enable the connector to communicate with your Engagement Cloud account and allow data synchronisation, you need to enter valid Engagement Cloud API credentials.  API user credentials are made up of a username and password, and are required to authenticate each operation/method call that's made and to make sure you're connected to the correct account.

To create an API user:

  1. Go to Settings > Access.
  2. Select the tab API users, and select New user.Screen_Shot_2018-03-09_at_2.54.07_PM.png
  3. Enter a description and password for the new API user.
  4. Select Enabled to activate the user.
  5. Select Save.

Create Transactional User 

You can make use of Engagement Cloud's transactional email service to send, manage and track all of your transactional emails. The transactional service acts as a delivery mechanism for all the transactional emails such as order and shipping confirmations.  If you are looking to use Engagement Cloud's easy editor to create and manage transactional emails for Magento please review the Transactional email templates article.

  1. Go to Settings > Access.
  2. Select the tab API users, and select New user.Screen_Shot_2018-03-09_at_1.54.17_PM.png
  3. Enter a description and password for the new API user.
  4. Select Enabled to activate the user.
  5. Select Save.

Enter API Credentials in Magento

Return to your Magento admin panel and select the Accounts option from the Engagement Cloud menu item.  This menu item can be accessed by navigating to Stores > Configuration.


Set 'Enabled' to Yes and then enter the credentials (username and password) of the API user just created


When finished click Save Config.  A confirmation is message is displayed notifying you the credentials are valid.

Enter Transactional Credentials in Magento

From Magento select Transactional Emails from the Engagement Cloud menu.


Select Yes to enable the feature then enter the hostname, username and password.

  • r1-smtp.dotdigital.com if you have an account belonging to region 1 (Europe)
  • r2-smtp.dotdigital.com if you have an account belonging to region 2 (North America)
  • r3-smtp.dotdigital.com if you have an account belonging to region 3 (Asia)


Select an open port. Your options are 25,587 and 2525.


Click Save when finished.

Multiple Environments

A separate set of credentials should be used for your live and staging sites.

Mapping Data Fields

In addition to the basic contact information, the connector provides you the ability to map over 40 key retail information that you store on contacts from your Magento website to your Engagement Cloud account.

To map the fields automatically choose the Developer option from the Engagement Cloud menu.


Under the Sync Settings sections choose Run Now next to the 'Automap Data Fields' option. After a few moments, the page is reloaded with a success message.


Address Books

The connector synchronises contacts to three different address books for three Magento contact types:

  • Customers - Registered customers of your Magento site that have a customer account.
  • Subscribers - Contacts who have opted into newsletter subscription on your site.
  • Guests - Email addresses from an order placed via guest checkout. They are neither a customer or a subscriber.

Before synchronisation begins, you need to create these address books so they can be selected and mapped to from within the connector.


Address books can be created directly within the connector or within your Engagement Cloud account.  To create address books from within the connector select the Sync Settings from the Engagement Cloud menu.


Select the Create Address Book section towards the bottom of the page. Provide the address book a name and select the visibility. Selecting 'public' means contacts will be able to join or unsubscribe from it.  When finished, click Create New Address Book.


Repeat the steps above until all address books are created.


Under the Address Book Mapping section choose the appropriate address books from the drop-down menu to map your customers, subscribers and guests to.


When finished with your mapping, select Save Config in the top right.


In Magento 2 version 3.2.4 upwards, site and ROI tracking are enabled by default.

Site tracking enriches your data and your understanding of your contacts' engagement with your site, whilst ROI tracking gives you a greater appreciation of your campaigns' ROI conversion rates.

Site Tracking is managed from Configuration.


From the Tracking section select Yes for 'ROI Tracking Enabled' and/or 'Page Tracking Enabled'. You can also put your Web Behavior Tracking Profile Id in the box, so you can start collect browsing insights by sessions. 


When finished, click Save Config.

Easy Email Capture

Easy email capture functionality will allow you to capture your site's user's email addresses when they haven't fully completed your checkout process or newsletter sign up process.

Easy Email Capture is managed from Configuration.


From the Abandoned Carts section select Yes for “Easy Email Capture (Checkout)” and/or “Easy Email Capture (Newsletter)”.


When finished, click Save Config.

Order Sync Settings

Import Status

You have the option to only import and synchronize orders of a certain status, rather than all of them. For example, you might only be interested in sending campaigns or running segments based on orders that have been fulfilled. In this case, you might only want to import orders in a “Complete” status.

The order settings is managed from Configuration.


From the Transactional Data section choose the status types to be imported from the "Import With Status" list.


When finished, click Save Config.

Custom Attributes

In addition to our standard default order data fields, you have the option to synchronize custom order attributes. This list comprises all of the order attributes that are available within the Magento system, allowing you to segment and send content based upon these too.

Under the Transactional Data section choose the attributes to be included in the import from the "Order Custom Attributes" list.


When finished, click Save Config.

Future Adjustments

Changes made to custom order attributes are reflected in new imports run after the adjustment has been made. To include these in previous imports the order insight collection must be deleted and the data re-imported

Catalog Sync Settings

The connector provides the facility to map and synchronise your product catalog against your Engagement Cloud account. With your product catalog synchronised, you will be able to insert products into campaigns with ease by utilising the 'Products' building block or setup Product Recommendations.

You can choose to sync products of a certain visibility and/or product type rather than all products. This allows you to keep your catalog organised by excluding products that are no longer relevant on your site.

The catalog settings is managed from Configuration.


From the 'Catalog Sync Settings' section choose the Store Value, Product Visibility and Product Types you want to sync.


When finished, click Save.

Broken Product Images?

Try setting the 'Catalog Values' to Store. This uses the store URL for the image path instead of the admin URL.

Enable Sync

After address books have been mapped and your order insight settings configured you can enable the data sync. Return to the Sync Settings page by selecting Sync Settings from the menu.


Under the Sync section select Yes to all sync types you would like to enable. Most enable Customer, Subscriber, Guest and Order.


Within 15 minutes contacts and insight data should begin to be batched.  Details for advanced synchronisation options such as Whistlist and Review can be found at Engagement Cloud for Magento


There is an hour delay prior to importing the order information. This delay is in place to prevent order imports from failing due to missing contacts.

Status Check

There are several ways to check that data is syncing from Magento into Engagement Cloud.

Contact Sync Report

Contacts that are successfully batch to be imported should be marked as imported. This is accessed under Sync Settings > Click here for status


Importer Status

Batched contacts/orders should exist in this report. Once the importer cron has run an import should be marked with a status of 'Importing‘. Shortly after data should appear in Engagement Cloud. This is accessed under Reports > Marketing Automation > Importer Status.




Confirm Engagement Cloud (ddg) cron jobs are running. Cron is a vital part of making sure your data syncing happens correctly. We recommend installing Cron Job Manager to give you a real-time view of the tasks running throughout your site, as well as giving you the ability to manage and configure your cron jobs.

API user

Confirm API credentials are active and valid.  You can view the status of the API credentials on the dashboard. The dashboard can be accessed under Reports > Dashboard.

Sync Enabled

Confirm at least one contact sync is turned on.

Check Permissions

Requires full access (0777) to the var/export directory or full access to the CRON user running on the server.

Abandoned Cart - Email Series

Abandoned cart emails are an important tool and key sales recovery strategy for ecommerce businesses. Research by marketing industry experts has suggested that around 70% of online consumers abandon carts. That means about one in three carts gets checked out first time.

Abandoned cart series are set up and configured directly within the interface of the connector and can be sent to customers and guests. Customers and guests can receive up to three different emails that are scheduled for different time intervals. If your Magento instance has more then once website, you can configure different emails and settings per website.

Using external dynamic content (EDC), you can include the contents of their cart within the body of the emails you send.

Need more flexibility?

If you require more flexibility with setting up abandoned carts you can enrol contacts into an Abandoned Cart Program. This allows you to use the Program Builder to tailor the abandoned carts to fit your business needs.  For example, you can include more emails or exit contacts based on specific types of behavior. This feature is only available in connector version 3.20 and above.


Abandoned carts use a series of trigger campaigns.  To create and build trigger campaigns login to your Engagement Cloud account.  From the main page choose the Automation menu item and then choose Trigger Campaign Content.


Access the email content and drag the External Dynamic Content building block into the location where you would like the cart content to be displayed.


Return to Magento and navigate to Dynamic Content.


Copy the Abandoned Cart URL and return to the campaign in Engagement Cloud.


Select the External Dynamic Content building block. Paste the Abandoned Cart URL previously copied to the 'Address' field then click Apply.


When done editing the campaign content click Save.

New to Automation?

If you are new to program building we suggest you watch the Automation training videos or review our Automation section.


After the campaigns have been created access the Abandoned Carts menu item from Magento


The page is broken down into two sections for Customers and Guests. Go through each section and enable the amount of abandoned cart emails you require.  Choose the time delay and Campaign to Send from each section as well.


When finished click the Save Config button.

Multiple Websites?

If you need to setup abandoned carts for separate websites select the website name from the site drop-down and then navigate to the Abandoned Cart menu item.

Status Check

You are able to check the status of abandoned cart emails by access the Campaign Sends report.  This can be accessed from the Magento 'Reports' menu item.


By reviewing this report you are able to tell whether abandoned cart emails are being queued for sending, whether they are being sent to Engagement Cloud and whether anything is failing.  You can sort and filter this report in a number of ways to find the information you're looking for.


External Dynamic Content

Confirm the external dynamic content link is correct that you’re using for pulling abandoned carts information into your campaign content. To check this select Dynamic Content from the Engagement Cloud menu in Magento.


Confirm ‘ddg_automation_abandonedcarts’ and ‘ddg_automation_campaign’ cron jobs are running. Without both of these running abandoned cart emails will not be batched or sent.


Disable extensions you might have used previously to send abandoned cart emails.

Did you find this article helpful?

Can we help?

Thanks for using Engagement Cloud. If you need more help or support, then contact our support team.