Documentation
APICreate a Ticket
  • 📔Documentation Guide
  • 📨Data & Engagement Platform
    • Data Model
      • Customer Data
      • Product Catalogue
      • Events
        • Onsite Events
        • Outbound Events
        • Transactions
    • App User Management
      • User Roles
      • App Users
    • Data Management
      • Data Management with API
      • Data Management with Data Feeds
        • Users
          • Import Users
          • Update or Delete a User Trait via File Upload
          • List of Standard User Traits/Attributes
        • Products
        • Events
          • Import Orders
          • Import Events
          • List of Events and Properties
      • Data Export
    • Web Tracking
      • Web Tracking v1 (Legacy)
        • Setup
        • Set up business Units
        • Tracking User Behavior
          • Identify Method
          • Page Method
          • Track Method
          • Opt-Out from Tracking
        • Testing & Debugging
      • Web Tracking v2
        • Setup using Google Tag Manager
        • Setup without a Tag Manager
        • Configuration & Config Commands
        • Tracking User Behavior
          • Identify Method
          • Update Method
          • Page Method
          • Track Method
          • Opt-Out from Tracking
        • Testing & Debugging
      • Migrate Tracking SDK v1 -> v2
      • Mobile Web Tracking
    • User Segmentation
      • Creating a Segment
      • Conditions
      • Combining Segments
    • Messages
      • Frequency Capping
      • Templates
        • Template Builder
      • Integrations
        • Channels
          • SMS
            • Twilio
              • Set up a Twilio Account
              • Set up Twilio Integration
              • Create a Campaign Message
            • Link Mobility
              • Set Up Link Mobility Account
              • Set up Link Mobility Integration
              • Create a Campaign Message
          • SFTP
            • Set up SFTP Integration
            • Create a Campaign Message
          • Direct Mail
            • Optilyz
              • Set up Optilyz Integration
              • Create a Campaign Message
          • Webhooks
            • Single Webhook
              • Set up Webhook Integration
              • Create a Campaign Message
              • Response Data and Custom Events
            • Batch Webhook
              • Set up Batch Webhook Integration
              • Create a Campaign Message
            • Zenloop via CrossEngage Webhook
              • Set up Zenloop Integration (via CrossEngage Webhook)
              • Set up Zenloop Survey
              • Create a Campaign Message
              • Set up Zenloop Survey via ESP
              • Obtain Response Data
            • Google Analytics via Webhook
          • Segment Transfer
            • Facebook
              • Set up Facebook Developer Account
            • Optimizely
              • Set up Optimizely Account
            • Google Analytics
              • Set up Google Analytics Integration
              • Create a Campaign with Google Analytics
              • Using the Google Analytics Integration
            • Airship
              • Set up an Airship Account
              • Set up an Airship Integration
              • Create a Campaign Message with Airship
          • Onsite Display
            • Trbo
              • Set up Trbo Integration
              • Create a Campaign Message in CrossEngage
              • Configure Campaign Message in Trbo
              • Obtain Response Data
          • Email
            • Mailjet
              • Set up Mailjet Integration
              • Obtain Response Data via Webhook
              • Create a Campaign Message
              • Personalize Preview Texts in Mailjet
            • Mandrill (by MailChimp)
              • Set up Mandrill Integration
              • Obtain Response Data via Webhook
              • Create a Campaign Messege
            • Inxmail
              • Set up Inxmail Integration
              • Create a Campaign Message
            • Sendgrid (by Twilio)
              • Set up SendGrid Integration
              • Obtain Response Data via Webhook
              • Create a Campaign Message
            • Mailgun
              • Set up Mailgun Integration
              • Obtain Response Data via Webhooks
              • Create a Campaign Message with Mailgun
            • Episerver (Optimizely)
              • Set up Episerver Integration
              • Create a Campaign Message with Episerver
          • Push Notifications
            • Airship
              • Set up an Airship Account
              • Set up an Airship Integration
              • Create a Campaign Message with Airship
        • Attachments
        • Delete an Integration
      • Personalization
        • Import Data
          • User Profile Data
          • Campaign Data
          • Cart Data
        • Formatting Functions
          • Date Formatting
          • Number Formatting
          • String Formatting
          • Hash Functions
        • General Helper Functions
          • Conditional Functions
          • Filtering Arrays
        • Product Helper Functions
          • Fetch from Product Feed
          • Fetch from Tracking Event
          • Fetch from User Journey
        • Misc. Helper Functions
          • Voucher Helper Function
            • Vouchers: Use Case
          • Event Helper Functions
          • Opt Out Helper Functions
        • Operators
      • Vouchers
        • Creating Vouchers
        • Using Vouchers
    • Campaign Management
      • Campaigns
        • Create an Audience Campaign
        • Create a Real-Time Campaign
        • Control Group
      • Stories
        • Building a Story
        • Use Case: Welcome Story
      • Segment Transfer
        • Create a Segment Transfer Campaign
    • Consent Management
      • Subscription/Consent Management
      • System Opt-Out/Opt-In
      • System Blacklist/Whitelist
    • Prediction Models
      • Create a new Model
      • Feature Engineering
      • SQL Filter
    • System Monitoring
      • Dashboard
        • Segment Tracker
      • Events Overview
      • Activity Log
      • Slack Notifications
        • Setting up Slack Notifications
    • Help & Support
      • System Status
      • Reach out to Customer Support
      • Suggest an Improvement
      • Privacy Policy
    • Glossary - Data & Engagement
  • 📈Predictions Platform
    • Data Model
      • Customer Data
      • Transactions
      • Activities
    • Overview
      • Data Tab
        • Data Tables in the Predictions Platform
      • Insights Tab
      • Model Builder Tab
        • Feature Engineering
        • Custom SQL Filter
        • Model Report
      • Prediction Tab
      • Selections Tab
    • Tutorials
      • Prepare and Validate Data
      • Analyze RFM Customers
      • Create a new Model
      • Predict Campaign Profit
    • Glossary - Predictions
Powered by GitBook
On this page
  • Before you begin
  • Set up your Episerver Account
  • Load user data on to CrossEngage
  • Get your Episerver Client ID
  • Get your Episerver Authorization Code
  • Configure the CrossEngage Episerver integration
  1. Data & Engagement Platform
  2. Messages
  3. Integrations
  4. Channels
  5. Email
  6. Episerver (Optimizely)

Set up Episerver Integration

PreviousEpiserver (Optimizely)NextCreate a Campaign Message with Episerver

Last updated 1 year ago

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 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

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.

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

📨
File exchange via SCP
API documentation