Configuring the extension

In Magento admin, navigate to Stores > Configuration > Integrations and select the "Voyado" tab.

Inside this configuration space, you'll be able to enable or disable the functionality supported by the extension.

Start by enabling the extension under “General” settings as seen in the video below.

You can connect your Voyado Engage environment/s to all your websites.

In the top left corner, change the website under “Scope”. You can choose to have a default setup for all websites, connected to one Voyado Engage environment (recommended), or configure websites separately, connecting each one to a separate instance.

Next, you'll need to input the credentials for your Engage environment.

This integration with Engage supports the sync of customers, guests and newsletter subscribers. These different types of customers are each stored in Voyado Engage as separate contact types.

To allow syncing of the Customer entity in Magento you will have to:

If you want to sync your guest customers and store them in Engage, follow these steps:

If you want to store your newsletter subscriptions in Engage:

With this setting you can choose to save ALL contacts - customers, guests and newsletter subscribers - as contact type "Member" in Engage.

The benefit of doing this is to minimize confusion and make for a cleaner integration. By only having the contact type "Member" it also means fewer calls to the Engage API. Voyado recommends this approach.

Arguably, using three different contact types might be useful if you want to separate different customers from each other in Engage. If you have a loyalty program, for example, and want that only account holders should be part of it, then it might be easier to have three types. However, this can also be done by making every customer have the contact type Member and using a HasAccount consent to tell them apart.

Voyado Engage requires a phone number to have a country calling code. If no validation for this is done in the front-end, and a phone number without a country calling code is input in checkout, the extension will validate that phone number based on the code of the country chosen in checkout.

For example:

In the configuration area you have the option of activating a two-way sync, allowing Engage to update customers in Magento 2. The two-way sync is connected to the login event in Magento 2, meaning that data is fetched from Engage and used to update the customer whenever they login to their account.

You can sync any or all of the name and address data or the newsletter subscription flag from Engage.

Follow these steps to enable to two-way sync:

Here are the fields in the contact model:

To sync purchases (called invoices in Magento) and returns (called credit memos in Magento) you must enable two separate exports. Activating these will allow you to create segments based on the contact's order history in Voyado Engage.

You can enable the invoice export at Export > Enable invoice export.

You can enable the credit memo export at Export > Enable credit memo export.

{
    "contact": {
        "contactType": "member",
        "matchKey": "f0352103-7143-4a44-a20d-af3300c58d7f",
        "matchKeyType": "ContactId"
    },
    "createdDate": "2022-11-08T12:49:43+00:00",
    "createdDateForXml": "2022-11-08T12:49:43+00:00",
    "currency": "EUR",
    "items": [
        {
            "articleName": "Joust Duffle Bag",
            "articleNumber": "24-MB01",
            "awardsBonus": true,
            "extraData": [],
            "grossPaidPrice": 85,
            "quantity": 2,
            "sku": "24-MB01",
            "taxAmount": "17.0000",
            "taxPercent": "25.0000",
            "type": "PURCHASE"
        }
    ],
    "paymentMethods": [
        {
            "description": "Payment for: 000000034",
            "type": "checkmo",
            "value": 85
        }
    ],
    "receiptNumber": "000000034",
    "storeExternalId": "opensource_demostore",
    "taxDetails": {
        "description": "TAX",
        "percent": "25.0000",
        "totalExcludingTax": 68,
        "totalIncludingTax": 85,
        "value": "19.5000"
    },
    "totalGrossPrice": 85,
    "uniqueReceiptId": "000000034"
}

{
    "contact": {
        "contactType": "member",
        "matchKey": "f0352103-7143-4a44-a20d-af3300c58d7f",
        "matchKeyType": "ContactId"
    },
    "createdDate": "2022-11-08T12:49:43+00:00",
    "createdDateForXml": "2022-11-08T12:49:43+00:00",
    "currency": "EUR",
    "items": [
        {
            "articleName": "Joust Duffle Bag",
            "articleNumber": "24-MB01",
            "awardsBonus": true,
            "extraData": [],
            "grossPaidPrice": 42.5,
            "quantity": -1,
            "sku": "24-MB01",
            "taxAmount": "8.5000",
            "taxPercent": "25.0000",
            "type": "RETURN"
        }
    ],
    "paymentMethods": [
        {
            "description": "Refund payment for: 000000034",
            "type": "Refund",
            "value": -42.5
        }
    ],
    "receiptNumber": "000000034",
    "storeExternalId": "opensource_demostore",
    "taxDetails": {
        "description": "TAX",
        "totalExcludingTax": 34,
        "totalIncludingTax": 42.5,
        "value": "8.5000"
    },
    "totalGrossPrice": -42.5,
    "uniqueReceiptId": "34-20"
}

If you enable the order export in the configuration area, you can choose to trigger transactional communication via Engage which will streamline the graphic design of your emails, whether they are transactional or marketing emails.

Navigate to Export > Enable order export to activate the export.

The following order states are supported “out of the box” by the extension:

Each order status can be individually enable and disabled.

The statuses in default Magento 2 implementation works like this:

Below are the "out of the box" data points included in transactional emails: 

Add the Magento tracking URL at Shipment settings > Add the Magento tracking URL also shown in the admin.

Setting this to “Yes” will add the default tracking link provided by Magento 2 which is available in admin.

Setting this option to “No” will allow you to add your transporter's tracking URL. When the transactional email is sent, the first tracking number found will be added to the URL and sent in the payload.

When you send a newsletter or email with a link to your customers in Engage, the links are encrypted with a contact identifier (contactId). This functionality can be used for various actions, such as triggering abandoned carts or product views through Engage's tracking script, or to personalize the experience on-site since Engage lets Magento know who the visitor is.

To enable soft identification:

When the customer arrives on-site via a soft identification link, the extension decrypts it, identifying the customer. When this setting is enabled, the extension then automatically pushes the contact identifier to dataLayer.

If you set the “Display in front-end” setting to "yes", it aids debugging by showing the response payload in the storefront.

Enabling this feature in the extension will allow you to act on cart abandonment and abandoned browse (beta). Engage will also calculate and store the ten top products of interest which can be used in segmentation as well as when generating content in emails.

This is a beta release and it's important to keep the following in mind:

The prerequisites for using web activity tracking are the following:

Follow these steps to enable web activity tracking:

Here is a video showing the configuration: