Set up Episerver Integration

Before you begin

You will need the following:

  • Episerver Account

  • CrossEngage Account

  • User data that includes an email address

Set up your Episerver Account

Set up File Exchange credentials

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

Details on how to set up the credentials are available in the File exchange via SCP article on Episerver. You need to be logged in to view the article. Please mention that the credentials are for a CrossEngage 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 CrossEngage for recipient information when sending campaign messages. These lists need to be created by Episerver. Send a request to Episerver support to set up a transaction recipient list for a CrossEngage integration. No specific data structure or list of columns is required for CrossEngage. The process for creating this may take a few days.

Request SOAP API credentials

SOAP API credentials are used by CrossEngage to access the Episerver API when sending campaign information. Send a request to Episerver support to obtain a username and password for a CrossEngage integration. The process for creating this may take a few days.

Load user data on to CrossEngage

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

Get your Episerver Client ID

  • Log in to your Episerver 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 CrossEngage integration setup.

Get your Episerver Authorization Code

  • Log in to your Episerver 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 CrossEngage integration setup.

Configure the CrossEngage Episerver integration

The following steps are to set up an Episerver integration on CrossEngage.

  • Log in to your CrossEngage 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 card.

  • Enter a descriptive account name, for example 'Episerver Live Account'.

  • In the 'Connection' section, there are three fields to configure:

    • Client ID - The client ID value you got from Episerver in the previous steps.

    • Username - The username value you got from Episerver support.

    • Password - The password value you got from Episerver 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 CrossEngage.

    • Key's passphrase - The passphrase that you configured for the private key. If you did not configure a value, leave this field blank.

  • 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 Episerver in the previous steps.

  • Select 'Apply' to save your integration.

Last updated