Selligent ESP Integration

Context

This page describes from a high level how integration with Froomle can be set up for Newsletters (E-mail campaigns) using Selligent as ESP (E-mail Service Provider). For detailed description, refer to the Selligent documentation.

The general process to generate batch recommendations, basically csv files sent across the 2 systems, is described here: How to generate batch recommendations.

Procedure

1. Customer creates a request file

Froomle needs a list of subscribed user_id’s for which recommendations need to be generated, together with some context of the request.

  • "environment"

  • "user_id"

  • "list_name"

  • "list_size"

  • "page_type”

For this use case the information is typically shared in a CSV file on the Froomle SFTP.

This feed can be set up using a Selligent export job.

⚠️ A crucial element is that the user_id’s known by Selligent have to match the user_id’s used in your online channel(s) and shared in events towards Froomle. Otherwise Froomle will not be able to identify the user and personalize.

2. Froomle generates recommendations in a response file

Triggered by the uploaded request file, Froomle generates a response file and places it on the SFTP server.

Froomle is able to return metadata to generate the entire recommendation block if needed. For example:

  • Title

  • Url

  • Image url

  • Intro text / description

Alternatively this information can be fetched by the customer if the article catalog is already being synced with Selligent.

3. Customer retrieves & processes response file

Using a stored procedure in Selligent, the customer:

  • Retrieves the response file (on a scheduled time or by polling the Froomle SFTP)

  • Retrieves additional article & user information if needed

  • All data is combined into an ‘article list’

  • Each article list receives an ID and this ID is saved per user on an action record in Selligent

4. Customer sends e-mail campaign

  • A campaign is created and is configured to listen for new action records

  • When these are created, information is gathered and campaign is being sent

5. Customer shares tracking events

The following tracking events should be shared with Froomle, either realtime on our APIor via a separate CSV feed on our SFTP. Tracking is set up in the same way you track other e-mail campaigns:

  • batch_open: when a mail has been opened by a user

    • Real-time: using a tracking pixel that calls the Froomle Event API upon loading

    • Batch: CSV feed via SFTP from Selligent

  • batch_click_on_recommendation: when a recommendation has been clicked by a user

    • Real-time: using website/app tracking to trigger a click event to the Froomle Event API in case the click comes from a mail campaign as referrer. Note: in this case Froomle expects both a batch_click_on_recommendation as a detail_pageview event

    • Batch: CSV feed via SFTP from Selligent