Enable triggered campaigns with generic ESP

  • Updated

Optimizely Email Product Recommendations lets you send triggered emails through your email service providers (ESPs) using an ESP client integration framework, through a generic ESP API. This integration framework acts as a proxy server between Triggered Messages and your ESP, as it is impossible to integrate directly with ESPs on each and every instance.

Prerequisites

  • Implement the generic ESP to receive the API response. The customer, partner, or the ESP need to ensure emails are sent to the users. 
  • Ensure your site is being tracked by the Optimizely Email Product Recommendations team.
  • The Product Recommendations team is receiving an updated product catalog feed. 

Configure the ESP connection and action

  1. Log in to the Optimizely Product Recommendations platform.
  2. Go to Configuration > ESP. 

  3. Open the Connections tab.

  4. Click Create ESP connection and enter the following information:
    • Connection name – Enter a name for your connection.
    • Name of ESP – Select Optimizely generic from the drop-down list. 
    • ESP server – Enter the URL of the server endpoint your team configured to handle requests from Optimizely Triggered Messages. 
    • ESP API key – (Optional) Enter the API key configured on your server to authenticate requests from Optimizely Triggered Messages.
  5. Click Save ESP connection to save the configuration.

  6. Click Test ESP connection to send a sample triggered message and test the ESP connection.

  7. Go to Actions > Create ESP action and enter the following information:
    • ESP action name – Enter a name for your ESP action.
    • ESP action type – Choose the type of action you want to perform (send message to the user, add a user to a group, or remove a user grom a group). Provide the parameters depending upon the action.   
    • Connections – Choose the ESP connection you previously created.

  8. Click Save ESP action to save the ESP action and Test ESP action to test its functionality. You will generate a Message ID or a Group ID.

Configure a Triggered Messages campaign

  1. Go to Configuration > Campaigns > Triggered Messages.
  2. Click Create campaign to create an Optimizely Triggered Messages campaign.

  3. Click Save campaign to save your campaign.

    Select the ESP action you created previously from the ESP action drop-down list. In Strategies > Session > In-session triggers, choose any trigger strategy (Abandoned checkout, Abandoned basket, or Abandoned browsed products). You can also choose as many Additional trigger actions as you want. 

Integrate with your ESP

When a trigger fires, Triggered Messages uses the generic ESP API to send the user's email address, a triggerFireID, and a Message ID or a Group ID to the generic ESP. You need to configure the following in your ESP with the received information:

  1.  
    • For Send message, replace the placeholders in the Email Product Recommendations template HTML code with the actual user's email address and the Message ID and triggerFireID sent through the API.
    • For Add user to group, add the user's email address to the group with the Group ID sent through the API. 
    • For Remove user from group, remove the user's email address from the group with the Group ID sent through the API.