Integrating Yotpo Loyalty & Referrals with Emarsys

      Integrating Yotpo Loyalty & Referrals with Emarsys


        Article Summary


        Products


        Loyalty
        Supported plans

        Platinum, Enterprise

        eCommerce Platform

        Shopify, Shopify Plus, Adobe Commerce (Magento), BigCommerce, Salesforce Commerce Cloud, Custom

        Emarsys creates software that enables truly personalized, one-to-one interactions between marketers and customers across all channels. Once connected to Yotpo Referrals, you'll be able to automatically pass program-related attributes and events directly into your Emarsys account.

        Sending rewards and referral program-related emails directly from Emarsys makes it easier to manage your marketing drips, ensure that customers receive the right email at the right time, and better target customers based on their program status.

        Before you start

        In order for the connection between Yotpo and Emarsys to work smoothly, you'll need to update your API permissions system to allow the two apps to communicate. To do so:

        1. Go to your Emarsys admin >Management> Security Settings > API Users and click the edit icon.
        2. Enable the following API endpoints: 
         List of endpoints

        Field
        field.get

        field.create

        Event
        externalevent.create

        externalevent.get

        externalevent.list

        externalevent.triggercontact.update

        contact.create

        contact.getdata

        Contact
        contact.update

        contact.create

        contact.getdata

        Customer

        customer.settings

        Getting started

        To enable the integration, sign in to the Emarsys Help Portal and request to enable the Yotpo Referrals integration within your Emarsys account.

        Once the integration is enabled in your account:

        1. Log in to Emarsys as the Account Owner
        2. Click Admin
        3. Click Security Settings
        4. Create your API Username and API Secret Key
        5. Make sure to copy these credentials and save them in a safe place as they cannot be retrieved later on.
        Please note:
        You must be logged in as the Emarsys account owner in order to create your API credentials. Learn more.

        Integrating Referrals and Emarsys

        Once you've enabled Yotpo Loyalty & Referrals in your Emarsys account and generated your API credentials, you'll need to connect Emarsys to your Yotpo Loyalty & Referrals account:

        1. Log in to Yotpo Loyalty & Referrals admin.
        2. Click on Integrations.
        3. Select Emarsys from the dropdown list of available integrations.
        4. Enter your Emarsys API credentials in the corresponding fields.
        5. Click Add Integration.
        Please note:
        Yotpo Referrals events and attributes will begin to sync as soon as the integration is added

        Loyalty & Referrals events in Emarsys

        Once connected, you can find externally mapped Yotpo Referrals events in your Emarsys admin.


        1. Log in to Emarsys.
        2. Click Admin.
        3. Click External Events.
        Loyalty and Referrals External Events
        • swell/points/earned
        • swell/redemption/created
        • swell/points/reminder
        • swell/redemption/reminder
        • swell/customer/birthday
        • swell/referral/share
        • swell/referral/completed
        • swell/tier/earned
        • swell/tier/lost
        • swell/purchase/payout/scheduled
        • swell/redemption/payout/scheduled
        • swell/purchase/payout/received
        • swell/purchase/payout/unclaimed
        • swell/redemption/payout/received
        • swell/referral/share/reminder
        • swell/referral_discount_code/updated
        • swell/birthday/captured
        • swell/redemption_code/below_threshold
        • swell/widgets/customer/authentication
        • loyalty/opt_in
        • loyalty/opt_out
        • loyalty/donation/created
        • loyalty/custom/reward/created
        • swell/points/changed
        • loyalty/anniversary/captured
        • swell/account/created
        • swell/newsletter/signup
        • loyalty/customer/anniversary
        • swell/referral_code/activated

        Event-based flows

        Event-based flows can be created through the Emarsys Automation Center:

        1. Click Campaigns.
        2. Click Automation Center.
        3. Create a new program from scratch by clicking Create Blank Program, or use an existing template by clicking Create Program From Blueprint and selecting the most relevant category.
          1. You may also edit an existing program by clicking Edit adjacent to the relevant program
        4. Add external events to your program using the External Event element in the Entry Points menu.
        5. Click External Event, click the External Event box, and then select the desired Yotpo Referrals event from the Node Settings menu.
        6. Add any other conditions or triggers you'd like.
        7. We recommend sending a test email to make sure your flow performs as intended.

        Including customer attributes in templates

        To include Yotpo Referrals customer attributes in Emarsys templates:

        1. Log in to Emarsys.
        2. Click Campaigns.
        3. Click Triggered Email.
        4. Click Create Mail Stream to create a new stream or edit an existing one.
        5. If creating a new stream, select Block-Based Email or Custom HTML Email.
        6. Create a new template or edit an existing one.
        7. Add Personalization Variableswhere relevant.
          1. Add event-related attributes in double brackets e.g. {{event.swell_perk_reward_points}} in line with Emarsys scripting language.
          2. Add customer attributes as {{contact.value of points balance param}}
            For example: {{ contact.100009777 }} where100009777 directly corresponds with the yotpo referrals points balance parameter defined in Emarsys.
            Please note:
            Attributes should be added in line with Emarsys Scripting Language (ESL) not as {{contact.swell_point_balance}}

        Was this article helpful?