Use Optimizely Triggered Messages with Optimizely Campaign
This topic describes how to connect Optimizely Triggered Messages to Optimizely Campaign.
Note
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 Triggered Messages and Email Product Recommendations. In Triggered Messages, you must also connect 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.
To set up the Triggered Messages-to-Campaign integration, do the following.
- Optimizely Recommendations Portal > Triggers, set up the following:
- ESP connection to connect to the Optimizely Campaign HTTP API. Enter the Recipient list authorization code, which is a token giving authorization access to a particular recipient list. See Retrieve the Recipient list authorization code, and also Set up an ESP connection.
- ESP action to set up one of the following actions:
- Send Message to user – Specify a Mailing ID for the email template in Optimizely Campaign. The previous chart shows this action being used. See Create a Send message to user action and also Set up an ESP action.
- Add user to target group – Specify a User property name and a User property value. See Create an Add user to target group action.
- Remove user from target group – Specify a User property name. See Create a Remove user from target group action.
- Set up an Optimizely Triggered Messages campaign with a specific strategy, such as Abandoned basket.
- In Optimizely Campaign, you need the following:
- A Recipient list.
Note
Triggered Messages can only send emails to existing users in the recipient list for compliance reasons.
To add users to the recipient list and make them available for Triggered Messages, you can use a Campaign API. 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 (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 Recommendations 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.
use-optimizely-triggered-messages-with-optimizely-campaign.mdxRetrieve the Recipient list authorization code
To retrieve the Recipient list authorization code:
- Open the Optimizely Campaign menu and select Administration > API Overview in Optimizely Campaign.
- Select Recipient lists to show its table.
- Select your recipient list from the table.
- Click Manage authorization codes.
- From the Manage Authorization Codes view, copy the authorization code.
- Paste the authorization code into the Recommendations Portal on the Triggered Messages >**** ESP connections page.
- Enter the connection name.
- Select Episerver Campaign as the name of your ESP.
- Click Test ESP connection.
- 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 recipient basket. To enable this feature, contact customer service.
For developer information, see Link to a specific basket on Optimizely World.
use-optimizely-triggered-messages-with-optimizely-campaign.mdxCreate an ESP action
See also Set up an ESP action.
use-optimizely-triggered-messages-with-optimizely-campaign.mdxCreate 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:
- Open the Optimizely Campaign menu and select Campaigns > Transactional****Mails in Optimizely Campaign.
- Copy the Mailing ID for your campaign from the ID column.
- In the Recommendations Portal, go to Configuration > Triggered Messages > ESP actions > selected action and paste the Mailing ID.
- ESP action name. Enter the action name.
- ESP connection. Select the connection that you created earlier.
- ESP action type. Select Send message to user.
- Mailing ID. Enter the campaign Mailing ID.
- Test ESP action. Enter the email address of the email recipient and click Test ESP action.
- If the test is successful, click Save ESP action.
use-optimizely-triggered-messages-with-optimizely-campaign.mdxCreate an Add user to group action
- Go to Configuration > Triggered Messages > ESP actions > selected action in the Recommendations Portal.
- ESP action name – Enter the action name.
- ESP action type – Select Add user to group.
- ESP connection – Select the connection that you created earlier.
- Group ID – Enter the group identifier.
- Test ESP action – Enter the user's email address and click Test ESP action.
- If the test is successful, click Save ESP action.
use-optimizely-triggered-messages-with-optimizely-campaign.mdxCreate a Remove user from group action
- Go to Triggers > New campaign > ESP actions page in the Recommendations Portal.
- ESP action name – Enter the action name.
- ESP action type – Select Remove user from group.
- ESP connection – Select the connection that you created earlier.
- Group ID – Enter the group identifier.
- Test ESP action – Enter the user's email address and click Test ESP action.
- If the test is successful, click Save ESP action.
use-optimizely-triggered-messages-with-optimizely-campaign.mdxSet 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.
- In the Recommendations Portal, go to Email Product Recommendations > Campaigns.
- Select and open your Email Product Recommendations campaign.
- In the Configuration tab, choose a trigger strategy.
- Go to the HTML and preview tab.
- Select Optimizely Campaign as the Email service provider.
- Click Generate code.
- Copy the HTML code displayed in the window.
- Go to Optimizely Campaign.
Note
To create a mailing in Optimizely Campaign, go to Campaigns > Transactional mails and follow the instructions in Transactional messages.
- Open the Optimizely Campaign menu and select Campaigns > Transactional Mails.
- Select your email campaign.
- Click Edit.
- In the Edit transactional mail window that opens, click the email node and click Edit
.
- Click Edit content.
- Add or find the Source Code paragraph in the editor where you want to insert the Optimizely recommendations. A separate Text/Image paragraph was added above for the heading Recommendation Paragraph in the image below.
- Click the HTML tab.
- In the Source code field, paste the HTML code (copied in step 6):
Note
You can modify the HTML to add the default image size sent for empty images with no products. If you do not change the HTML, the default for width and height is 1px for empty images with 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>
- Click Apply.