Current version: v1.9.0

...

The module synchronizes customer data, order data and shopping cart information between Magento and Maileon. Magento is the primary system, which means that the customer information in Magento is considered the main information and changes to that data are synchronized with Magento. Conversely, only certain information is synchronized: the DOI confirmation and unsubscription. For order details and cart abandonments, this information is sent to Maileon as transactions (events) and can be used either to analyze data using contact filters or to activate a trigger mailing. All functions can be set via a configuration panel in Magento.

Install the Module

Below version 1.0.8

The first step is to copy the Maileon directory into the /app/code directory of the Magento installation. If the app directory doesn't already contain a code subdirectory please create it. After this the module must be enabled using the following steps:

...

php bin/magento setup:upgrade

Configuration in Magento

The configuration can be found under “Stores” “Configuration” and, since version 1.8, can be set on Storeview level. This means, that for each Storeview, you can select an own API key, to use different Maileon accounts or you can select different DOI mail keys to send out DOIs in e.g. different languages.

...

• Active: This enables the order confirmation module. This module synchronizes order events to Maileon. Each order creates two types of transactions: magento_orders_v2 and magento_orders_extended_v2. The transaction magento_orders_v2 contains one event for each order. The transaction magento_orders_extended_v2 contains one event per line item in the order.

• Enable separate permission for buyers: If this setting is enabled, customers who do not yet exist in Maileon and have not unsubscribed will be created with the permission set below. They will be granted instant permission even if the permission are DOI or DOI+

• Buyers permission: If the above option is enabled, you can set the permission here

After version 1.9 you do not need to disable Magento order confirmation emails in the settings. (Configuration/Sales/Sales Emails → Order)

Transaction type magento_orders_v2

...

Configuring Custom Forms

In order to submit other standard or custom data to Maileon, the following scheme must be used:

...

Example: custom_MySpecialField

Enhancing Transactional Data

In some cases, it is required to add custom data transactions. E.g. if you use a plugin, which allows customizing products with names, custom images, etc., and the image shall be displayed in the order confirmation mail, you need to pass this URL to Maileon. Or this case, the plugin provides a simple way to add data to the transactions by overriding class Maileon\SyncPlugin\Helper\External\Data from an external plugin.

...

If everything was installed as expected, the next time e.g. an order is triggered, some additional data should be attached to it.

Webhook Settings in Maileon

Changed parameters in version 1.8:
Since Magento 2.4, an email can be added as newsletter subscriber for each storeview, thus, the email can exist multiple times in the Magento newsletter module. As of version 1.8 of the plugin, configuration is based on storeview level, thus, an email can be added to different Maileon newsletter accounts based on its origin. Thus, when Maileon reports back a DOI confirmation or unsubscription, it needs to identify the correct storeview for a given contact. This is done by adding a new parameter “storeview_id”.

...

The token must match the value given for the DOI Hook Token given in Magento settings.

...

Changelog

2023.06.14 - v 1.9.0

• Add customer account related transactions

• Add order related transactions

• Improve abandoned carts functionality

...