Set up Episerver/Optimizely Campaign Integration

This integration went through several names, because the company changed its name from Optivo to Episerver and now Optimizely over the years. For historical reasons all of these names may appear in connection to this integration.

Before you begin

You will need the following:

  • Optimizely Campaign Account
  • ActivatePro Account
  • User data that includes an email address

Set up your Optimizely Campaign Account

Set up File Exchange credentials

Optimizely Campaign uses a file server to exchange campaign and message information. File exchange credentials are necessary for ActivatePro to integrate with your Optimizely Campaign account.

Details on how to set up the credentials are available in the Transferring files through SFTP article on Optimizely Campaign. You need to be logged in to view the article. Please mention that the credentials are for a ActivatePro integration when contacting Episerver support. The process for enabling the credentials may take a few days.

Request a transactional recipient list

Transactional recipient lists are used by ActivatePro for recipient information when sending campaign messages. These lists need to be created by Optimizely. Send a request to Optimizely Campaign support to set up a transaction recipient list for a ActivatePro integration. No specific data structure or list of columns is required for ActivatePro. The process for creating this may take a few days.

Request SOAP/REST API credentials

API credentials in form of a user with specific permissions are used  to access the Optimizely Campaign API when sending campaign information. Send a request to Optimizely Campaign support to obtain a username and password for a  ActivatePro integration. The process for creating this may take a few days.

Get your Optimizely Campaign Client ID

  • Log in to your Optimizely Campaign account.
  • Select 'API Overview' under the 'Administration' heading.
  • Select the 'SOAP API' tab.
  • Your Client ID is the value under the 'Client ID' heading. You will need this in the ActivatePro integration setup.

Get your Optimizely Campaign Authorization Code

  • Log in to your Optimizely Campaign account.
  • Select 'API Overview' under the 'Administration' heading.
  • Select the 'Recipient Lists' tab.
  • Select the 'Transactionlist' list.
  • Select the 'Manage authorization codes' button.
  • If there are no values in the table, select the 'Create authorization code' button.
  • Your Authorization Code is the value under the 'Authorization code' heading. Make sure the status next to the value is 'active'. You will need this in the ActivatePro integration setup.

Configure the ActivatePro Optimizely Campaign integration

The following steps are to set up the integration:

  • Log in to your ActivatePro account.
  • Select 'Settings', and then 'Integrations'.
  • Select the 'Add new integration' button.
  • From the list of integrations, select the 'Set up' button on the Episerver/Optivo card.

    integration_optimizely-episerver.png

  • Enter a descriptive account name, for example 'Optimizely Campaign Live Account'.
  • In the 'Connection' section, there are three fields to configure:
    • Client ID - The client ID value you got from Optimizely Campaign in the previous steps.
    • Username - The username value you got from Optimizely Campaign support.
    • Password - The password value you got from Optimizely Campaignr support.
  • In the 'FTP connection' section, there are three fields to configure:
  • FTP username - The FTP username you got from Episerver support.
  • Private Key - The content of the private key you configured. Open the file and paste the content in ActivatePro.
  • Key's passphrase - The passphrase that you configured for the private key. If you did not configure a value, leave this field blank.

    integration_optimizely-episerver2.png

  • Select 'Connect' to save the connection details.
  • In the 'Settings' section, there are two fields to configure:
    • Transactional list - The recipient list that will be used to send emails.
    • Transactional list authentication key - The authorization code value that you got from Optimizely Campaign in the previous steps.
  • Select 'Apply' to save your integration.

Load user data on to ActivatePro

Instructions on how to load users onto the ActivatePro platform via API can be found in the Create & Update Users section of our API documentation.