Reconnect Email Integration

Setting up the custom integration

To set up an integration with your ESP:

1. In Reconnect, go to the Integrations tab, and then click Create Channel Integration.
2. Select the Email channel, and then complete the following information in the integration wizard.

Step 1: Configure 

• Name: The integration name is included in your campaigns and their reports.
• HTTP Post URL: Your ESP's messaging endpoint.
• HTTP Header Parameters (optional): You can insert header parameters in a key:value format. Click the lock icon to encrypt the value. The value displays as masked, and is encrypted before it's saved to our database.
• Identifier Type: Select the user identification method required by your ESP. The corresponding value is included in the message JSON when you use the User Identifier variable.
  For example, if you select Email, and insert the User Identifier variable into your JSON payload in a campaign, it's replaced with the user's email address, which you provided as part of the identification process.

Click Next.

Step 2: Authenticate

Select the authentication method required by your ESP:

• No Auth: No authorization is required, so there are no additional parameters to configure.
• Basic Auth: Enter a valid username and password as provided by your ESP.
• OAuth2: Enter a token URL, client ID, and client secret, as provided by your ESP.
  • You can change the key names of the client ID and secret in the token header parameters section.
  • By default, the client secret value is encrypted for security purposes.

When you click Next, the system validates the credentials you provided against the token URL. If they are invalid, an error is displayed.

Step 3: Test

To test your integration, send a test API call to your ESP:

• Request Headers: Displays the parameters you entered in the previous steps.
• JSON Payload:
  1. Enter the message body, in JSON format, as your ESP expects to receive it.
  2. Click Test. An API call is sent to the ESP messaging endpoint you defined earlier.
• Request Response: This is the response from your ESP server.

If everything is working as expected, click Save. The integration appears in the Integrations tab. 

With this integration, Reconnect triggers emails from your ESP, enabling you to manage frequency capping, view reports, and generally maintain more control over how Reconnect emails are sent as part of your complete email program.

Prerequisites

• The Responsys integration enabled on your account. Contact your technical account manager for assistance.

Enable the integration

1. In Responsys, create an API user. Set to the role API Admin.
2. In Experience OS, go to Reconnect › Integrations › Create Channel Integration › Email and select Oracle Responsys.
3. In the Responsys Integration wizard, complete these steps, as described in the following sections:
   1. Configure
   2. Authenticate
   3. Test
4. If everything works as expected, save the integration. 

Step 1: Configure

1. Set the HTTP Post URL. This is the Responsys endpoint to which Dynamic Yield sends the POST request. By default, this is the Trigger Email Message endpoint, but you can modify it to use the Trigger Custom Event endpoint for additional flexibility. When a message is sent to Responsys, the ${dyCampaignName} variable injected to the last route of the endpoint is replaced with the relevant Reconnect campaign name. 
   After the username and password are authenticated, the complete URL is stored by Dynamic Yield and used to trigger calls to the defined endpoint.
2. Select the Identifier Type. This must be the same one you use in your identification events.
   • Email: Select if your opted-in email addresses feed or Opt-in and Opt-out events events use raw email addresses as the identifier.
   • Phone Number: Select if your opted-in email addresses feed or Opt-in and Opt-out events use phone numbers as the identifier.
   • Other: Select if your Opt-in and Opt-out events events use any other identifier that isn't an email address or a phone number.

Step 2: Authenticate 

1. Enter the Token URL issued by Responsys in your account.
2. Username and Password: Enter your Responsys credentials to gain access to Responsys REST APIs. 

Step 3: Test

1. When authentication is complete, click Next to text the communication via the endpoint you defined in the Configure step, and view the server response.
2. For testing purposes, you can change the campaign name in the URL. This doesn't affect the endpoint. You can also insert a test message in the JSON Payload field. 

3. Click Test. The response is displayed in the Request Response field.

1. In Reconnect, go to Integrations › Create Channel Integration › Email and select Emarsys.

2. In the integration wizard, complete the following steps:

   1. Configure: Select the identifier type you use to identify users:
      • Email: Plain text email addresses.
      • Phone number
      • Other: Any string your ESP can map to an email address.
        Important: If you select this option, you must also implement an Identify User event on your site, even if you already have another identification event implemented, such as Signup, Login, or Newsletter Subscription. 
   2. Authenticate: Upload the Emarsys credentials JSON file. The file is available on your Emarsys account or from your Emarsys account representative. 

   Sample Emarsys credentials file: 

   {
     "type": "service_account",
     "project_id": "project-id",
     "private_key_id": "key-id",
     "private_key": "-----BEGIN PRIVATE KEY-----\nprivate-key\n-----END PRIVATE KEY-----\n",
     "client_email": "service-account-email",
     "client_id": "client-id",
     "auth_uri": "https://accounts.google.com/o/oauth2/auth",
     "token_uri": "https://accounts.google.com/o/oauth2/token",
     "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
     "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
    }

   3. Test: Validate the integration by making a test call to Emarsys. Copy the JSON body that you plan to send later on, in your campaigns.
      You can copy the following sample JSON payload, which contains parameters you might need for a cart abandonment campaign, including the user identifier, items in the cart and their metadata, and the tracking pixel. In the em_dy_user_id field, insert the email address to which you want to send the test email (if you replace any of the parameters, make sure to keep the JSON format valid):

   {
    "em_dy_event_id": "af2e9aca-cb41",// a unique identifier
    "em_dy_event_type": "abandoned_cart",
    "em_dy_event_time": "2020-10-09T07:35:45Z",// time of send
    "em_dy_user_id": "john.d@mail.com",// plain text email
    "profile": {
      "userAttrs": [
        {
          "content": {
            "itemsInCart": [
              {
                "sku": "2264",
                "name": "LSL Women Little Red Dress",
                "image": "http://acme.com/pub/media/catalog/product/w/d/wd001.jpeg",
                "link": "https://www.acme.com/tremclk/?cuid=john.d%40mail.com&cuidType=ihe&sec=8772046&expId=0&expVer=0&expVisitId=&mech=0&smech=&va=&targetUrl=http://lifestylelabels.com/lsl-women-little-red-dress.html",
                "price": 330
              },
              {
                "sku": "2504",
                "name": "LSL Women Blazer Zip - Red",
                "link": "https://www.acme.com/tremclk/?cuid=john.d%40mail.com&cuidType=ihe&sec=8772046&expId=0&expVer=0&expVisitId=&mech=0&smech=&va=&targetUrl=http://lifestylelabels.com/lsl-women-blazer-zip-red.html",
                "image": "http://acme.com/pub/media/catalog/product/w/b/wb001_3.jpg",
                "price": 750
              }
            ],
            "recommendations": [
              {
                "sku": "81467",
                "name": "Flawless Concealer",
                "link": "https://www.acme.com/tremclk/?cuid=john.d%40mail.com&cuidType=ihe&sec=8772046&expId=0&expVer=0&expVisitId=&mech=0&smech=&va=&targetUrl=http://lifestylelabels.com/lsl-women-blazer-zip-red1.html",
                "image": "http://acme.com/pub/media/catalog/product/w/b/wb001_4.jpg",
                "price": 75
              },
              {
                "sku": "83601",
                "name": "Contouring Blush & Bronzing Powder",
                "link": "https://www.acme.com/tremclk/?cuid=john.d%40mail.com&cuidType=ihe&sec=8772046&expId=0&expVer=0&expVisitId=&mech=0&smech=&va=&targetUrl=http://lifestylelabels.com/lsl-women-blazer-zip-red2.html",
                "image": "http://acme.com/pub/media/catalog/product/w/b/wb001_5.jpg",
                "price": 50
              }
            ]
          }
        }
      ]
     },
   
    "hiddenPixel": [
      "<im​g src="\" alt="alt" width="\" border="\" height="\" style="\;">"
    ]
   }</im​g>

3. Click Save to enable the integration.

With this integration, Reconnect triggers emails from your Klaviyo account, enabling you to manage frequency capping, view reports, and generally maintain more control over how Reconnect emails are sent as part of your complete email program.

Prerequisites

One or both of the following set up: 

• Opted-in email addresses feed
• Update Reconnect Opt-in and Opt-out events

Enable the integration

In your Klaviyo account:

1. Click your account avatar and then select Settings.
2. Go to API Keys and copy the relevant private key.
   Note: If you have not yet created a key, click Create Private API Key, and grant it full access permissions.

In Experience OS:

1. Go to Reconnect › Integrations › Create Channel Integration › Email and select Klaviyo.
2. In the Klaviyo integration wizard, complete the steps, as described in the following sections below:
   1. Configure
   2. Authenticate
   3. Test
3. If everything works as expected, save the integration. 

Step 1: Configure

Select the Identifier Type. This must be the same one you use in your identification events and Opt-in events/feed.

• Email: Select if your opted-in email addresses feed or Opt-in and Opt-out events use raw email addresses as the identifier.
• Phone Number: Select if your opted-in email addresses feed or Opt-in and Opt-out events use phone numbers as the identifier.
• Other: Select if your Opt-in and Opt-out events events use any other identifier that isn't an email address or a phone number.

Step 2: Authenticate 

Paste the private API key you copied from your Klaviyo account and then click Next.

Step 3: Test

1. In the JSON Payload input field, use the predefined JSON body that is expected, or enter any JSON expected by Klaviyo:
   
2. Click Test. The API response from Klaviyo is displayed.
3. Click Save. The new integration now appears in the Integrations tab. 

For this integration, Reconnect uses the SendGrid Mail Send API endpoint, with a JSON API call body.

Note that the integration supports existing SendGrid account credentials. Use the same API keys you currently use in the Triggered Email app. 

Enable the integration

1. Go to Reconnect › Integrations › Create Channel Integration › Email and select SendGrid.
2. In the Configure step, select the identifier type you use to identify your users on the SendGrid platform. Click Next.
3. In the Authenticate step, enter your designated API key, provided by SendGrid (the API key can be found in your SendGrid account under Settings › API Keys). Click Next.
4. In the Test step, enter a test JSON body, and then click Test.
5. If everything works as expected, save the integration. 

Create a template in the SendGrid platform

Sendgrid enables you to create dynamic templates with reusable HTML designs, which are triggered by an external API call from Reconnect.

1. In Sendgrid, go to Email API › Dynamic Templates.
2. Click Create a Dynamic Template and enter a name. Click Create.
   
3. The template is created in the grid. Click it.
   Note: When a template is created, it's assigned a unique Template ID. Use this ID in the JSON payload of the API request, as created in the Reconnect campaign.
4. Click Add Version.
5. When a version is created, you can edit it using either a code editor or a design editor. For ease of use, we recommend working with the design editor. If what Sendgrid offers in its design editor does not align with your design requirements, use the code editor to edit the HTML code directly.
6. To inject the data sent from Reconnect in the API call (as part of the campaign triggering), replace relevant content with dynamic variables by inserting double curly brackets (like this: {{variable name}} ). Learn more about which variables can be used in the message.
   
7. To preview simulated content, go to the editor's Preview tab, and click {} Show Test Data.
   

Important: In the HTML code editor, make sure that the email’s product components can support not being displayed when a value is returned empty. You can do this using conditional statements.

For this integration, Reconnect uses the Iterable POST /api/email/target endpoint with a JSON API call body.

Enable the integration

1. Go to Reconnect › Integrations › Create Channel Integration › Email and select Iterable.
2. In the Configure step, select the identifier type you use to identify your users on the Iterable platform. Click Next.
3. In the Authenticate step, enter your designated API key, provided by Iterable (the API key can be found in your Iterable account under Settings › API Keys). Click Next.
4. In the Test step, enter a test JSON body, and then click Test.
5. If everything works as expected, save the integration. 

Creating campaigns with Iterable

Iterable enables campaigns to be triggered by an external triggering event (API request) sent from Reconnect. Follow these steps to set up reusable campaigns that will be triggered by your Reconnect flows:

1. In the Iterable platform, go to Messaging › Campaigns. Click New campaign and select Email.
2. Name your campaign, and select API-Triggered.
3. When creating the HTML for your Email in the campaign, use Iterable Merge Tags (Handlebars) to inject the personalized data from the Reconnect triggering API call to your Email content (example follows).
   

4. Each campaign is assigned a unique ID. Copy this ID from Iterable and paste it into the relevant Reconnect campaign's JSON body, as the value for the campaignId parameter. 
   For example:

   { 
     "campaignId": 10732344, 
     "recipientEmail": "user@dynamicyield.com", 
     "userId": "", 
     "dataFields": { 
       "firstName": "Jane", 
       "lastName": "Smith", 
       "purchaseAmount": 42.42 
     } 
   }