Use Optimizely Triggered Messages with Optimizely Campaign

  • Updated

This topic describes how to connect Optimizely Triggered Messages to Optimizely Campaign.

To use Triggered Messages with Optimizely Campaign, your system administrator or developer must configure tracking first. When tracking is configured, you can continue to set up Triggered Messages following the steps described here.

Send triggered emails

You need to create a mailing campaign in Optimizely Campaign, and campaigns in both Triggered Messages and Email Product Recommendations. In Triggered Messages, you also need to create a connection to your recipient list in Optimizely Campaign and specify the appropriate action to take.

The following image shows the flow, through Triggered Messages and Optimizely Campaign, when users abandon their basket triggering an email to be sent to them directly.

Image: Triggers-to-Campaign flow chart

To set up the Triggered Messages-to-Campaign integration, do the following.

  • Optimizely Personalization Portal > Triggers, set up the following:
  • In Optimizely Campaign, you need the following:
    • A Recipient list.

      For compliance reasons, Triggered Messages can only send emails to users that already exist in the recipient list.

      To add new users to the recipient list and make them available for Triggered Messages, you can use a Campaign API. For more information on Campaign's APIs, see Optimizely Campaign's APIs and libraries.

      See the legal requirements regarding the advertising consent of the recipients.

    • A Transactional mail campaign.
    • Set up an associated transactional mail campaign in Optimizely Campaign by copying the generated HTML code from Email Product Recommendations and pasting it into the email template (with that Mailing ID) on the Optimizely Campaign portal. The HTML code contains placeholders that the ESP (that is, Optimizely Campaign) replaces with the actual values for each email sent.

When an Optimizely trigger fires, using the Optimizely Campaign HTTP API, Triggered Messages sends Optimizely Campaign the following for a Send Message action:

  • Recipient list authorization code – A Recipient list authorization code creates a connection between Optimizely Campaign and the Personalization Portal, and adds the triggerFireId to a user’s entry in the recipient list.
  • Mailing ID – For Send Message, for that Mailing ID, Optimizely Campaign replaces the placeholders in the Email Product Recommendations template HTML code with the values sent in the API request.
    • triggerFireId – Replaced with the ID of the Triggered Messages campaign sent in the API request.
    • Either of the following:
      • recipientid – Replaced with the user’s email address sent in the API request.
      • bmThirdPartyId – Replaced with the user's email address mapped from their pseudonymized user ID.

Retrieve the Recipient list authorization code

To retrieve the Recipient list authorization code:

  1. Open the Optimizely Campaign menu and select Administration > API Overview in Optimizely Campaign.
  2. Select Recipient lists to show its table.
  3. Select your recipient list from the table.
  4. Click Manage authorization codes.

    Image: Manage Authorization Codes button

  5. From the Manage Authorization Codes view, copy the authorization code.

    Image: Manage Authorization Codes screen

  6. Paste the authorization code into the Personalization Portal, on the Triggered Messages > ESP connections page.

    Triggers4-a.png

  7. Enter the connection name.
  8. Select Episerver Campaign as the name of your ESP.
  9. Click Test ESP connection.
  10. If the connection was successful, click Save ESP connection.

Link to a specific basket

Optimizely can integrate links from an email recommendation to a particular basket of the recipient. To enable this feature, contact customer service.

For developer information, see Link to a specific basket on Optimizely World.

Create an ESP action

See also Set up an ESP action.

Create a Send message action

To send messages using Triggered Messages directly to users, you need to provide the Mailing ID of the Optimizely Campaign campaign on the Triggered Messages ESP action page. You can retrieve the Mailing ID by following these steps:

  1. Open the Optimizely Campaign menu and select Campaigns > TransactionalMails in Optimizely Campaign.
  2. Copy the Mailing ID for your campaign from the ID column.

    Image: Copy Mailing ID for your campaign from the ID column

  3. In the Personalization Portal, go to Configuration > Triggered Messages > ESP actions > selected action and paste the Mailing ID.

    Triggers12-a.png

    1. ESP action name. Enter the action name.
    2. ESP connection. Select the connection that you created earlier.
    3. ESP action type. Select Send message to user.
    4. Mailing ID. Enter the campaign Mailing ID.
    5. Test ESP action. Enter the email address of the email recipient and click Test ESP action.
  4. If the test is successful, click Save ESP action.

Create an Add user to group action

  1. In the Personalization Portal, go to ConfigurationTriggered Messages > ESP actions > selected action.

    Triggers9-b.png

    1. ESP action name – Enter the action name.
    2. ESP action type – Select Add user to group.
    3. ESP connection – Select the connection that you created earlier.
    4. Group ID – Enter the group identifier.
    5. Test ESP action – Enter the email address of the user and click Test ESP action.
  2. If the test is successful, click Save ESP action.

Create a Remove user from group action

  1. In the Personalization Portal, go to Triggers > New campaign > ESP actions page.

    Triggers10-b.png

    1. ESP action name – Enter the action name.
    2. ESP action type – Select Remove user from group.
    3. ESP connection – Select the connection that you created earlier.
    4. Group ID – Enter the group identifier.
    5. Test ESP action – Enter the email address of the user and click Test ESP action.
  2. If the test is successful, click Save ESP action.

Set up an email campaign in Optimizely

The following procedure shows how to generate HTML code to copy from Optimizely Email Product Recommendations into a mailing in the Optimizely portal.

  1. In the Personalization Portal, go to Email Product Recommendations > Campaigns.
  2. Select and open your Email Product Recommendations campaign.
  3. In the Configuration tab, choose a trigger strategy.
  4. Go to the HTML and preview tab.
  5. Select Optimizely Campaign as the Email service provider.
  6. Click Generate code.
  7. Copy the HTML code displayed in the window.

    Image: Example of generated HTML code

  8. Go to Optimizely Campaign.

    To create a new mailing in Optimizely Campaign, go to Campaigns > Transactional mails and follow the instructions in Transactional messages.

  9. Open the Optimizely Campaign menu and select Campaigns > Transactional Mails.
  10. Select your email campaign.
  11. Click Edit.
  12. In the Edit transactional mail window that opens, click the email node and click Edit .
  13. Click Edit content.
  14. In the editor, add or find the Source Code paragraph where you want to insert the Optimizely recommendations. In the image below, a separate Text/Image paragraph was added above for the heading Recommendation Paragraph.
  15. Click the HTML tab.
  16. In the Source code field, paste the HTML code (copied in step 6):

    You can modify the HTML to add the default image size that is sent for empty images that have no products. If you do not change the HTML, the default for both width and height is 1px for empty images that have no products. For example: 

    <a href="https://abcde.optimizely.net/link.page?e={bmThirdParty}&site=clientsite&wid=12345&rno="0"><img src="https://abcde.optimizely.net/image.page?widthIfEmpty=100&heightIfEmpty=200&e={bmThirdPartyID}&site=clientsite&wid=12345&rno=0" alt="Just for you" title="Just for you" /></a><a href="https://abcde.optimizely.net/link.page?e={bmThirdParty}&site=clientsite&wid=12345&rno="0"><img src="https://abcde.optimizely.net/productinfo.page?widthIfEmpty=100&heightIfEmpty=200&e={bmThirdPartyID}&site=clientsite&wid=12345&rno=0" alt="Just for you" title="Just for you" /></a>

    Image: Paste copied HTML code

  17. Click Apply.