Integrate Engagement Cloud with Magento 2

Learn to integrate your Engagement Cloud account with Magento 2.

Overview

Integrating Engagement Cloud with Magento 2 is a five-part process. Follow the video as we demonstrate exactly how simple it can be. If you need a bit of extra guidance, don't worry, we've written out the steps below.

This example shows a generic integration based on a common use-case. You might want to modify certain things depending on your particular requirements – feel free to tweak as you go. If at any time you need any help, reach out to our support team.

Watch the video

Before you start

To use this integration guide, you must use Magento version 2.2.2 or higher.

Set up your workspace:

  1. Open two browser tabs.
  2. In the first tab, go to your Magento 2 admin and log in.
  3. In the second tab, go to your Engagement Cloud account and log in.

1. Establish connectivity

To start with, you must establish a connection between Magento 2 and Engagement Cloud. This is a two-step process where you first create an API user in Engagement Cloud and then add your API user to the connector settings in Magento 2.

Step 1: Create an API user.

To create an API user in Engagement Cloud:

  1. In Engagement Cloud, go to Settings > Access > + New user.
    add-new-user.png
  2. Enter a description. This should describe the use of the API user.

    In the video example, we enter Magento 2.

  3. Enter and confirm a password.
  4. Under Status, choose Enabled.
  5. Select Save.

Your API user is now ready to connect.

Step 2: Add your API User to the connector settings in Magento 2.

To add an API user to the connector in Magento 2:

  1. In Engagement Cloud, go to Settings > Access > API Users.
  2. Copy the API email address.
  3. In Magento 2, go to Stores > Configuration, and under Engagement Cloud, select Accounts.
    connector-settings.png
  4. Under Settings, select the Enabled drop-down menu and choose Yes.
    api-settings.png
  5. Paste your API email address to the Email address box.
  6. Enter your password to the Password box.
  7. Select Save Config.

That’s it. If the connection is successful, the message API Credentials Valid appears at the top of the page.

2. Create and map address books

In this step, you create and map your address books. This is a two-step process where you first create your Engagement Cloud address books and then map them in Magento 2. You can do all this in the Magento admin. If you have previously created your Engagement Cloud address books, you can skip to step-two Map address books.

Before you start

The connector lets you sync three different contact types between Magento 2 and Engagement Cloud:

  • Customers
    Contacts who have created an account on your website;
  • Subscribers
    Contacts who have opted in to marketing communications
  • Guests
    Contacts who have made a purchase through the guest checkout.

In the video demonstration, we sync all three contact types.

Step 1: Create Engagement Cloud address books.

  1. In Magento 2, go to Stores > Configuration and under Engagement Cloud, select Sync Settings.
    sync-settings.png
  2. Under Create Address Book, enter the name of your address book.

    In the video example, we create Customers.

    create-addressbook.png

  3. Under the Visibility drop-down menu, select Private.
  4. Select Create New Address Book.
  5. Repeat to create additional address books for Subscribers and Guests.

Please note

Address books can also be manually created within Engagement Cloud.

 Step 2: Map address books.

  1. In Magento 2, go to Stores > Configuration. Under Engagement Cloud, select Sync Settings and find the heading Address Book Mapping.
    sync-settings.png
  2.  Under Allow non-subscribed contacts to be imported, you must choose if you want to import non-subscribed contacts into Engagement Cloud. We recommend selecting No
    addressbook-mapping.png
  3. Under Add Customers To, select Customers.
  4. Under Add Subscribers To, select Subscribers.
  5. Under Add Guests To, select Guests.
  6. Select Save Config.

3. Enable synchronisation

At this point, you turn on synchronisation and choose what information you want to sync.

To turn on synchronisation and set your sync settings:

  1. In Magento 2, go to Stores > Configuration. Under Engagement Cloud, select Sync Settings and find the heading Sync.
    sync-settings.png
  2. Under Customer Enabled, Guest Enabled, and Subscriber Enabled drop-down menus, select Yes (for all three).
    sync-settings-panel.png
  3. Select Yes for any other options you would like to allow synchronisation for.
    In the video example, we also select yes for Order Enabled, and Catalog Enabled.
  4. Select Save Config.

4. Map data fields

It’s now time to map your data fields to each other. We have a handy tool to do this automatically for you, but you can do it manually if you want to.

Automatically map data fields

  1. In Magento 2, go to Stores > Configuration. Under Engagement Cloud, select Developer and find the heading Sync settings.
    developer-nav.png
  2. Under Admin Task, find Automap Data Fields and select Run Now.

    This automatically creates and maps any missing data fields.

    admin-task.png
  3. Once complete, an All Data Fields Created And Mapped success message shows.
    success-message.png

Manually map data fields

  1. In Magento 2, go to Stores > Configuration. Under Engagement Cloud, select Data Mapping.
    data-mapping-nav.png
  2. Under Data Fields Mapping, use the drop-down menus to map your data fields manually.
    data-fields-mapping.png
  3. Once complete, select Save Config.

5. Synchronise data

Finally, you need to synchronise your data between Magento 2 and Engagement Cloud. Syncs automatically takes place when the next cron job runs in Magento 2, this is typically within 15 minutes, but if you want to speed up the process, you can sync manually.

Manually sync data

To manually sync your data:

  1. In Magento 2, go to Stores > ConfigurationUnder Engagement Cloud, select Developer.
    developer-nav.png
  2. Under Manually Run Sync, select Run Now to manually sync any of the sync options.

    In the video example, we select Run Now for Contacts Sync, Subscriber Sync, and Order Sync.

    manual-sync.png
  3. Under Importer Sync, select Run Now to manually run the import.

Confirming the sync was successful

To confirm your sync was successful.

  1. In Engagement Cloud, go to Contacts.
  2. Look for the address books you added to Engagement Cloud. If you see them, go to step 3.
  3. Look to see if the address books contain contacts and information.

If you can see your address books and related contact information, you have successfully integrated Engagement Cloud with Magento 2. Nice one!

If you’re having problems with the sync, contact our support team for help.

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.