1 Introduction
2 Installation
- 2.1 Install via Composer
- 2.2 Install via ZIP package
  - 2.2.1 Below version 1.0.8
  - 2.2.2 From version 1.8.1
- 2.3 Enable the module
3 Configuration in Magento
4 Enhancing Transactional Data
5 Webhook Settings in Maileon
- 5.1 Unsubscription Webhook Setup
- 5.2 DOI Confirmation Webhook Setup
6 Changelog

Introduction

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.

Installation

Install via Composer

The module can be installed using Composer with the following command:

composer require xqueue/module-maileon

Install via ZIP package

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:

From version 1.8.1

Copy the Maileon plugin to the Magento root folder (/sources/magento-2/Xqueue/Maileon/). Add the following line to the Magento composer.json:

"require": {
    "xqueue/module-maileon": "^1.8"
},

"repositories": [
    {
        "type": "composer",
        "url": "https://repo.magento.com/"
    },
    {
        "name": "xqueue/module-maileon",
        "type": "path",
        "url": "sources/magento-2/Xqueue/Maileon"
    }
],

Run composer update at command line

Enable the module

Before enable the module, we must check to make sure Magento has recognize our module or not by enter the following at the command line:

php bin/magento module:status

If you follow above step, you will see this in the result:

List of disabled modules:
Xqueue_Maileon

This means the module has recognized by the system but it is still disabled. Run this command to enable it:

php bin/magento module:enable Xqueue_Maileon

If the above succeeded the following message is displayed:

The following modules has been enabled:
Xqueue_Maileon

This’s the first time you enable this module so Magento require to check and upgrade module database. We need to run this command:

php bin/magento setup:upgrade

If everything went well you can switch to Magento’s admin interface. The plugin settings are available in the following menu:

Stores -> Configuration -> Maileon

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.

Figure 1: Maileon Extension Settings

General Settings

Figure 2: General settings

Maileon Api Key: The API key associated with the Maileon account you wish to use. At Maileon Settings → API Keys.

Subscriber Settings

Figure 3: Subscriber settings

Enable: This enables the newsletter subscriber module. This module synchronizes new subscriptions to Maileon.
Initial Permission: The initial permission level to set for new Maileon subscribers.
- None: No permission. The contact will not receive newsletters.
- Single Opt-in: Permission was simply granted, e.g. by entering an email address in a form. This method technically allows the contact to receive newsletters, but does not ensure that the email address belongs to the person who entered it.
- Confirmed Opt-in: A confirmation mail about the registration is sent to the provided email address, but it does not contain a confirmation link. This method is frequently abused by spammers. The recipient will have to actively revoke consent in order not to receive any advertising emails.
- Double Opt-in: With this permission, a confirmation email with a confirmation link is sent to the email address. Only when the link in the mail has been clicked and thus the interest in the entry has been confirmed, the contact can be sent.
- Double Opt-in Plus: Double opt-in including consent for single user tracking.
  Please note: Without individual user tracking, no openings, clicks, etc. may be traced back to individual users and significant data for evaluating newsletter performance is missing.
Double Opt-in Process: A confirmation email including a “confirmation link” is sent to the provided email address. The subscription will not be valid until the recipient clicks this link. Thus it is ensured that the recipient is identical to the mailbox owner and really wishes to receive your emailings (the recipient cannot click the confirmation link without having signed in to her or his mailbox). Double Opt-in is the only subscription method we can recommend. Please note that XQ can only provide general information but no official legal counselling. Please contact your lawyer in the case of legal questions on this topic.
Double Opt-In Plus (DOI+): Requires option “DOI Process”. A DOI+ permission will be registered after the user clicks the DOI confirmation link in the DOI mail.

Please note: You can only obtain significant response analyses and react appropriately when your contacts have given consent to single user tracking. Taking into account that only the double-opt-in procedure is legally safe (for German-based providers), the only permission method we can recommend is “Double Opt-in including consent to single user tracking”.

DOI Mailing ID: If the permission above is set to DOI or DOI-Plus the newsletter subscriber will be sent a confirmation mailing using Maileon. This field can be used to customize which DOI mailing will be sent from Maileon. Leaving it empty means that the default DOI confirmation will be sent. (A default DOI confirmation mailing must be set in Maileon in order for this to work.)
Unsubscribe Webhook Token: This token is used to synchronize Maileon unsubscribers back to Magento. This field must be a unique string. (Think of it as a password.) The webhook setup will be detailed later.
DOI Confirmation Webhook Token: This token is used to synchronize Maileon DOI confirmations back to Magento. If set the Magento subscriber state will match the Maileon subscription state of each customer. This field must be a unique string. (Think of it as a password.) The webhook setup will be detailed later.
Unsubscribe All Matching Emails: Since Magento 2.4, the same email address can be subscribed multiple times across different store views. In Maileon, contacts may belong to different newsletter accounts per store view, so Magento needs the store view ID to unsubscribe a specific contact correctly.
If the storeview_id is missing:
- Yes: all Maileon contacts with the matching email will be unsubscribed.
- No: the unsubscription will be ignored. It is recommended to configure proper store view ID passing and/or enable this option.
Disable Newsletter Confirmation Request Email: Disable Magento's built-in newsletter confirmation request email for newsletter subscriptions.
Disable Newsletter Subscription Success Email: Disable Magento's default newsletter subscription success email sent after newsletter subscription confirmation.
Disable Ensubscription Email: Disable Magento's default email sent when a customer unsubscribes from the newsletter.

Order Confirmation Settings

Figure 4: Order Confirmation Settings

Enabled: 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.
Disable Order Confirmation Email: Disable Magento's default order confirmation email sent after a successful checkout.
Enable Separate Permission For Buyers: Enable a separate permission level for customers who complete a purchase, 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`

Field name	Type	Description

Field name	Type	Description
`order.id`	string	Order id (incremental id)
`order.date`	timestamp	Order timestamp
`order.status`	string	Order status
`order.total`	float	Order grand total
`order.total_tax`	float	Order tax amount
`order.total_no_shipping`	float	Order total without shipping cost
`order.currency`	string	Order currency
`shipping.service.name`	string	Shipping method
`payment.method.id`	string	Payment id
`payment.method.name`	string	Payment name
`order.items`	JSON	Ordered items in json
`shipping.address.firstname`	string	Shipping address first name
`shipping.address.lastname`	string	Shipping address last name
`shipping.address.phone`	string	Shipping address phone
`shipping.address.region`	string	Shipping address region
`shipping.address.city`	string	Shipping address city
`shipping.address.zip`	string	Shipping address zip
`shipping.address.street`	string	Shipping address street
`billing.address.firstname`	string	Billing address first name
`billing.address.lastname`	string	Billing address last name
`billing.address.phone`	string	Billing address phone
`billing.address.region`	string	Billing address region
`billing.address.city`	string	Billing address city
`billing.address.zip`	string	Billing address zip
`billing.address.street`	string	Billing address street
`generic.string_1`	string	Store ID
`generic.string_2`	string	Store name

Transaction type `magento_orders_v2` `order.items`

Field name	Type	Description

Field name	Type	Description
`product_id`	string	Product id
`title`	string	Product title
`single_price`	float	Product single price
`total`	float	Item total price
`sku`	string	Product sku
`quantity`	integer	Item quantity
`url`	string	Product url
`image_url`	string	Product image url
`categories`	string	Product categories list separated with ,
`short_description`	string	Product short description

Transaction type `magento_orders_extended_v2`

Field name	Type	Description

Field name	Type	Description
`order.id`	string	Order id (incremental id)
`order.date`	timestamp	Order timestamp
`order.status`	string	Order status
`order.total`	float	Order grand total
`order.total_tax`	float	Order tax amount
`order.total_no_shipping`	float	Order total without shipping cost
`order.currency`	string	Order currency
`shipping.service.name`	string	Shipping method
`payment.method.id`	string	Payment id
`payment.method.name`	string	Payment name
`product.id`	string	Product id
`product.title`	string	Product title
`product.single_price`	float	Product single price
`product.total`	float	Item total price
`product.sku`	string	Product sku
`product.quantity`	integer	Item quantity
`product.image_url`	string	Product image url
`product.url`	string	Product url
`product.categories`	string	Product categories list separated with ,
`product.short_description`	string	Product short description
`shipping.address.firstname`	string	Shipping address first name
`shipping.address.lastname`	string	Shipping address last name
`shipping.address.phone`	string	Shipping address phone
`shipping.address.region`	string	Shipping address region
`shipping.address.city`	string	Shipping address city
`shipping.address.zip`	string	Shipping address zip
`shipping.address.street`	string	Shipping address street
`billing.address.firstname`	string	Billing address first name
`billing.address.lastname`	string	Billing address last name
`billing.address.phone`	string	Billing address phone
`billing.address.region`	string	Billing address region
`billing.address.city`	string	Billing address city
`billing.address.zip`	string	Billing address zip
`billing.address.street`	string	Billing address street
`generic.string_1`	string	Store ID
`generic.string_2`	string	Store name

Customer Related Email Notification settings

Figure 5: Customer Related email Notifications

Customer Credentials Changed (Password and/or Email): If this option is enabled, it will send a transaction to Maileon in cases where the customer changes their email address and/or password. Transaction type: magento_account_credentials_changed_v1
Disable Customer Credentials Changed Email: Disable Magento's default customer credentials changed email.
Customer Password Reminder: If this option is enabled, it will send a transaction to Maileon in case when the customer wants a password reminder. Transaction type: magento_password_reminder_v1
Disable Password Reminder Email: Disable Magento's default password reminder email.
Customer Password Reset Confirmation: If this option is enabled, it will send a transaction to Maileon in case when the customer wants a password reset. Transaction type: magento_password_reset_confirmation_v1
Disable Password Reset Email: Disable Magento's default password reset email.
New Account Notification: If this option is enabled, it will send a transaction to Maileon in case when the customer create a new account. If Magento is configured to confirm the email address when creating a new account, it sends an email address confirmation notification, if not, it sends a welcome notification Transaction type: magento_new_account_v1
Disable New Account Email: Disable Magento's default new account email.

Transaction type `magento_account_credentials_changed_v1`

Field name	Type	Description

Field name	Type	Description
`fullname`	string	Customer full name
`changed_field`	string	The changed field name (email, password)
`store_id`	string	Store id
`store_name`	string	Store name
`store_email`	string	Store email address
`store_phone`	string	Store phone

Transaction type `magento_password_reminder_v1`

Field name	Type	Description

Field name	Type	Description
`fullname`	string	Customer full name
`account_url`	string	Customer account url
`psw_reset_url`	string	Customer password reset url
`store_id`	string	Store id
`store_name`	string	Store name

Transaction type `magento_password_reset_confirmation_v1`

Field name	Type	Description

Field name	Type	Description
`fullname`	string	Customer full name
`psw_reset_url`	string	Customer password reset url
`store_id`	string	Store id
`store_name`	string	Store name

Transaction type `magento_new_account_v1`

Field name	Type	Description

Field name	Type	Description
`fullname`	string	Customer full name
`type`	string	Notification type: `customer/create_account/email_template` : welcome email, when confirmation is disabled and password is set `customer/create_account/email_no_password_template` : welcome email, when confirmation is disabled and password is not set `customer/create_account/email_confirmation_template` : welcome email, when confirmation is enabled and password is set `customer/create_account/email_confirmed_template` : email with confirmation link
`account_url`	string	Customer account url
`account_confirm_url`	string	Customer account confirmation url
`psw_reset_url`	string	Customer password reset url
`store_id`	string	Store id
`store_name`	string	Store name

Order Related Email Notification Settings

Figure 6. Order Related Email Notification Settings

Payment Status Change: If this option is enabled, it will send a transaction to Maileon in cases when a credit memo is created or updated for the order. Transaction type: magento_order_creditmemo_v1 , magento_order_creditmemo_update_v1
Disable Payment Status Change Email: Disable Magento's default payment status changed email.
Invoice: If this option is enabled, it will send a transaction to Maileon in cases when a invoice is created or updated for the order. Transaction type: magento_order_invoice_v1 , magento_order_invoice_update_v1
Disable Invoice Created Email: Disable Magento's default invoice created email.
Order Status Change: If this option is enabled, it will send a transaction to Maileon in cases when the order status changed. Transaction type: magento_order_status_changed_v1
Disable Order Status Changed Email: Disable Magento's default order status changed email.
Shipment Status Change: If this option is enabled, it will send a transaction to Maileon in cases when a shipment is created or updated for the order. Transaction type: magento_order_shipment_v1 , magento_order_shipment_update_v1
Disable Shipment Status Changed Email: Disable Magento's default shipment status changed email.

Transaction types `magento_order_creditmemo_v1` , `magento_order_creditmemo_update_v1`

Field name	Type	Description

Field name	Type	Description
`order.id`	string	Order id (incremental id)
`order.date`	timestamp	Order timestamp
`order.status`	string	Order status
`order.total`	float	Order grand total
`order.total_tax`	float	Order tax amount
`order.total_no_shipping`	float	Order total without shipping cost
`order.currency`	string	Order currency
`shipping.service.name`	string	Shipping method
`payment.method.id`	string	Payment id
`payment.method.name`	string	Payment name
`order.items`	JSON	Ordered items in json
`shipping.address.firstname`	string	Shipping address first name
`shipping.address.lastname`	string	Shipping address last name
`shipping.address.phone`	string	Shipping address phone
`shipping.address.region`	string	Shipping address region
`shipping.address.city`	string	Shipping address city
`shipping.address.zip`	string	Shipping address zip
`shipping.address.street`	string	Shipping address street
`billing.address.firstname`	string	Billing address first name
`billing.address.lastname`	string	Billing address last name
`billing.address.phone`	string	Billing address phone
`billing.address.region`	string	Billing address region
`billing.address.city`	string	Billing address city
`billing.address.zip`	string	Billing address zip
`billing.address.street`	string	Billing address street
`order.creditmemo.id`	string	Order credit memo id
`order.comment`	string	Order comment
`store.id`	string	Store id
`store.name`	string	Store name

Transaction types `magento_order_invoice_v1` , `magento_order_invoice_update_v1`

Field name	Type	Description

Field name	Type	Description
`order.id`	string	Order id (incremental id)
`order.date`	timestamp	Order timestamp
`order.status`	string	Order status
`order.total`	float	Order grand total
`order.total_tax`	float	Order tax amount
`order.total_no_shipping`	float	Order total without shipping cost
`order.currency`	string	Order currency
`shipping.service.name`	string	Shipping method
`payment.method.id`	string	Payment id
`payment.method.name`	string	Payment name
`order.items`	JSON	Ordered items in json
`shipping.address.firstname`	string	Shipping address first name
`shipping.address.lastname`	string	Shipping address last name
`shipping.address.phone`	string	Shipping address phone
`shipping.address.region`	string	Shipping address region
`shipping.address.city`	string	Shipping address city
`shipping.address.zip`	string	Shipping address zip
`shipping.address.street`	string	Shipping address street
`billing.address.firstname`	string	Billing address first name
`billing.address.lastname`	string	Billing address last name
`billing.address.phone`	string	Billing address phone
`billing.address.region`	string	Billing address region
`billing.address.city`	string	Billing address city
`billing.address.zip`	string	Billing address zip
`billing.address.street`	string	Billing address street
`order.invoice.id`	string	Order invoice id
`order.comment`	string	Order comment
`store.id`	string	Store id
`store.name`	string	Store name

Transaction type `magento_order_status_changed_v1`

Field name	Type	Description

Field name	Type	Description
`order.id`	string	Order id (incremental id)
`order.date`	timestamp	Order timestamp
`order.status`	string	Order status
`order.total`	float	Order grand total
`order.total_tax`	float	Order tax amount
`order.total_no_shipping`	float	Order total without shipping cost
`order.currency`	string	Order currency
`shipping.service.name`	string	Shipping method
`payment.method.id`	string	Payment id
`payment.method.name`	string	Payment name
`order.items`	JSON	Ordered items in json
`shipping.address.firstname`	string	Shipping address first name
`shipping.address.lastname`	string	Shipping address last name
`shipping.address.phone`	string	Shipping address phone
`shipping.address.region`	string	Shipping address region
`shipping.address.city`	string	Shipping address city
`shipping.address.zip`	string	Shipping address zip
`shipping.address.street`	string	Shipping address street
`billing.address.firstname`	string	Billing address first name
`billing.address.lastname`	string	Billing address last name
`billing.address.phone`	string	Billing address phone
`billing.address.region`	string	Billing address region
`billing.address.city`	string	Billing address city
`billing.address.zip`	string	Billing address zip
`billing.address.street`	string	Billing address street
`order.comment`	string	Order comment
`store.id`	string	Store id
`store.name`	string	Store name

Transaction types `magento_order_shipment_v1` , `magento_order_shipment_update_v1`

Field name	Type	Description

Field name	Type	Description
`order.id`	string	Order id (incremental id)
`order.date`	timestamp	Order timestamp
`order.status`	string	Order status
`order.total`	float	Order grand total
`order.total_tax`	float	Order tax amount
`order.total_no_shipping`	float	Order total without shipping cost
`order.currency`	string	Order currency
`shipping.service.name`	string	Shipping method
`payment.method.id`	string	Payment id
`payment.method.name`	string	Payment name
`order.items`	JSON	Ordered items in json
`shipping.address.firstname`	string	Shipping address first name
`shipping.address.lastname`	string	Shipping address last name
`shipping.address.phone`	string	Shipping address phone
`shipping.address.region`	string	Shipping address region
`shipping.address.city`	string	Shipping address city
`shipping.address.zip`	string	Shipping address zip
`shipping.address.street`	string	Shipping address street
`billing.address.firstname`	string	Billing address first name
`billing.address.lastname`	string	Billing address last name
`billing.address.phone`	string	Billing address phone
`billing.address.region`	string	Billing address region
`billing.address.city`	string	Billing address city
`billing.address.zip`	string	Billing address zip
`billing.address.street`	string	Billing address street
`order.shipment.id`	string	Order shipment id
`order.comment`	string	Order comment
`store.id`	string	Store id
`store.name`	string	Store name
`shipping.service.id`	string	Carrier code
`shipping.service.tracking.url`	string	Tracking popup url
`shipping.service.tracking.code`	string	Tracking code

`order.items` json content

Field name	Type	Description

Field name	Type	Description
`product_id`	string	Product id
`title`	string	Product title
`single_price`	float	Product single price
`total`	float	Item total price
`sku`	string	Product sku
`quantity`	integer	Item quantity
`url`	string	Product url
`image_url`	string	Product image url
`categories`	string	Product categories list separated with ,
`short_description`	string	Product short description

Abandoned Cart Settings

Figure 7: Abandonment Cart Settings

Enabled: This enables the cart abandonment module. This module synchronizes abandoned cart events to Maileon.
Fallback permission: the permission a contact will get when added to Maileon. This should be set to none in most cases.
Hours Before Sending Reminder: This is the number of hours after an open cart is considered abandoned.
Shadow Email: This email address also receives a copy of the cart abandonment email.
Email Override: If this field is set customers won’t receive cart abandonment emails. This address will receive them instead.

Transaction type `magento_abandoned_carts_v2`

Field name	Type	Description

Field name	Type	Description
`cart.id`	string	The cart id (quote id)
`cart.date`	timestamp	The cart last updated timestamp
`cart.items`	JSON	Cart items
`cart.product_ids`	string	Cart items product ids in a list
`cart.categories`	string	Cart items product category names in a list
`cart.total`	float	Cart grand total
`cart.total_tax`	float	Cart tax amount
`cart.currency`	string	Cart currency
`customer.salutation`	string	Customer salutation
`customer.full_name`	string	Customer full name
`customer.firstname`	string	Customer first name
`customer.lastname`	string	Customer last name
`customer.id`	string	Customer id
`generic.string_1`	string	Store ID
`generic.string_2`	string	Store name

Configuring Custom Forms

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

Standard fields: The standard fields must use the prefix standard_, followed by the exact name and providing the correct format, documented on http://dev.maileon.com/api/rest-api-1-0/contacts/standard-contact-fields/
Example: standard_FIRSTNAME
Custom fields: I custom fields should be submitted, they need to have the prefix custom_. Capitalization needs to be respected exactly as specified in Maileon.

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.

To ease development, we provide a test plugin that shows a minimalistic setup. In di.xml, the class is overwritten with an own implementation:

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

    <preference for="Maileon\SyncPlugin\Helper\External\Data" type="Maileon\TestPlugin\Helper\External\Data" />

</config>

Investigating class Maileon\TestPlugin\Helper\External\Data, which is provided by the test package and can be also named freely, there are different methods that can be used.

This method adds attributes to a single product within an order. Based on the product, e.g. a URL of a custom image could be retrieved and returned in the array:
getCustomProductAttributes($product)
This method adds attributes to an order, directly. As we are working with a transaction directly, make sure to use as a key one of the valid keys provided in the transaction type definition¹:
getCustomOrderTransactionAttributes($transaction_content)
This method adds attributes to single item transactions, directly. As we are working with a transaction directly, make sure to use as a key one of the valid keys provided in the transaction type definition²:
getCustomOrderExtendedTransactionAttributes($transaction_ext_content)

This method adds attributes to a single product within an card abandonment transaction. Based on the product, e.g. a URL of a custom image could be retrieved and returned in the array:
getCustomAbandonedCartProductAttributes($product)

This method adds attributes to a cart abandonment transaction, directly. As we are working with a transaction directly, make sure to use as a key one of the valid keys provided in the transaction type definition³:
getCustomAbandonedCartTransactionAttributes($transaction_content)

The data can be added e.g. by writing it to one of the free generic string fields:
$result['generic.string_1'] = "this is an additional information";

This value can then be used in a mailing to print it, use it as a link or an image URL.

The installation of the plugin is as expected done by using Composer. Install in the same way as the current plugin (see above)

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”.

Unsubscription Webhook Setup

The unsubscription webhook is used to synchronize Maileon unsubscribers back to Magento. To set this up in Maileon you must navigate to Settings/Webhooks. In this panel click Create new webhook. Select Unsubscription from the event dropdown. Enter the following for HTTP post URL (substituting your own domain):

https://<my domain>/rest/V1/maileon/webhook-unsubscribe

e.g.: https://maileonmagento.com/rest/V1/maileon/webhook-unsubscribe

Add the following URL parameters:

email -> contact field value -> E-mail address
token -> user-defined value -> <token>
storeview_id -> contact field value -> magento_storeview_id

The token must match the value given for the Unsubscribe Webhook Token given in Magento settings.

Figure 9: Webhook Settings for Unsubscriptions

Please note: To now anonymize the contact field “magento_storeview_id” in case of an unsubscription, it is required to configure Maileon accordingly.

DOI Confirmation Webhook Setup

The DOI confirmation webhook is used to synchronize Maileon DOI confirmations back to Magento. To set this up in Maileon you must navigate to Settings/Webhooks. In this panel click Create new webhook. Select DOI Confirmation from the event dropdown. Enter the following for HTTP post URL (substituting your own domain):

https://<my domain>/rest/V1/maileon/webhook-doi-confirm

eg.: https://maileonmagento.com/rest/V1/maileon/webhook-doi-confirm

Add the following URL parameters:

email -> contact field value -> E-mail address
token -> user-defined value -> <token>
storeview_id -> contact field value -> magento_storeview_id

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

Figure 11: Webhook Settings for DOI-Confirmations

Changelog

2025.05.15 - v1.10.0

Contact events are now reliably sent to Maileon whenever Magento sends a transactional email (order, invoice etc.).
Email sending logic now supports separate enable/disable toggles for each type (order, invoice, shipment, etc.).
Complete internal refactoring of the module for improved maintainability and code quality.
Replaced all method overrides with Magento event-based architecture where possible.
Refactored newsletter subscription handling to eliminate deprecated loadByEmail() usage.
Removed direct use of ObjectManager in favor of dependency injection.

2025.04.08 - v1.9.6

Added store_id and store_name as generic fields to order confirmation and abandoned cart transactions

2024.12.02 - v1.9.5

Fix product.short_description max. 1000 char length at orders extended transaction types

2024.10.22 - v1.9.4

Fix order.categories and order.product_ids max. 1000 char length at transaction types
Add plugin status reporter cron job

2023.11.02 - v1.9.3

Add getCustomOrderTransactionAttributes() helper method to order confirm transaction

2023.10.16 - v1.9.2

Fix Maileon confirm webhook when the subscriber not exists at Magento 2

2023.08.25 - v1.9.1

Fix mixed type declarations

2023.06.14 - v1.9.0

Add customer account related transactions
Add order related transactions
Improve abandoned carts functionality

2023.04.06 - v1.8.12

Bugfix: AfterPlaceOrder product categories

2022.12.06 - v1.8.11

Abandoned cart work with storeviews

2022.10.25 - v1.8.10

Update Maileon Php API client minimum version

2022.08.30 – v1.8.9

Added payment method ID and name to order transactions

2022.05.13 – v1.8.8

Enhancing of loading images in abandoned carts when model is not initialized in cron job, yet

2022.05.11 – v1.8.7

Change in URLs for images inside abandoned cart transactions
Compatibility fix for 2.4.4

2022.01.25 – v1.8.6

Changing DB table creation to declarative model

2022.01.18 – v1.8.5

Added thumbnail to abandoned carts transaction

2021.11.19 – v1.8.4.1

Added description about how to enable Maileon to send contactfield storeview_id to the Magento webhook when unsubscribing

2021.11.17 – v1.8.4

Fixed users getting redirected to blank page after subscribing in some Magento versions
Fixed error message when specifying wrong storeview ID in webhooks
Added configuration for testing abandoned carts

2021.09.13 – v1.8.3

Add functionality to add separate Maileon permission for buyers

2021.09.10 – v1.8.2

Resubscribe with same email address fix

2021.07.13 – v1.8.1

Recreate the package to work with composer

2021.07.07 – v1.8

Plugin configuration extended to storeview level
Add extra parameter to DOI confirmation and unsubscribe webhook to identify the correct storeview
Add a custom field to contact: magento_storeview_id
Add a custom field to contact: magento_source
Renamed plugin from Maileon_SyncPlugin to Xqueue_Maileon in order to match marketplace requirements. Manual deinstallation and reinstallation needed for updating. Configuration will be kept.

2021.02.04 – v1.7

Updated subscriber logic to support “initial” and “target” permission separately

2021.01.27 – v1.6

Added new settings for fallback permissions for orders and cart abandonments

2021.01.15 – v1.5

Added new Maileon webhooks API URLs, to process DOI confirm and unsubscribe webhooks
Bugfix at abandoned carts methods in case of exceptions
Add new fields to order transactions and round the float values to two digits

2020.11.24 – v1.4

Added overwritable class for enriching transactions with custom data
Switching to default transaction type definitions defined at https://dev.maileon.com/api/implementation-guideline/implementation-guidelines-transactions/
Fixing warning about deprecated syntax in Maileon API client

Magento 2