Synchronizing Tracking Events

Events are interactions of your users with your website or application. They are often associated with an item, but don’t have to be. Examples of user interactions that lead to an event are when a user opens an article detail page, clicks on a recommendation or purchases a product or subscription. The recommendations Froomle serves are based on these events.

This page explains which events we need for a working integration and how to share events with Froomle.

Event priority

Froomle supports a broad collection of event types to capture specific user behavior. The following table describes the priority of the different user event types.

  • News Events

  • E-Commerce Events

Priority Use User Events

Must for go-live

Module Optimization


Module Optimization, Analysis and Reporting


Analysis and Reporting


Should have

Module Optimization, Analysis and Reporting


Could have

Analysis, Reporting and Module Optimization


Analysis, Reporting and Module Optimization


Event Integration Connectors

Events API

Usually events are communicated to Froomle using the Events API. This is a simple REST API that can be integrated both front-end or back-end depending on your needs. Specifications of event structure and all available events are documented on our event specification page.

Code templates

You can use our templates for JavaScript/Swift/Kotlin to set up sharing of recommendations and/or events with Froomle in your front-end. These examples explains how to do this.

Publish events to Froomle PubSub

Froomle runs on the Google Cloud Platform. We allow you to publish events directly on our PubSub stream. To allow this we will follow the following steps:

  • Froomle & customer agree on the events that will be shared

  • Froomle provides PubSub specs & access

  • Customer maps events to the Froomle standard structure

  • Customer links their event stream to Froomle’s stream (file format is flexible tsv, csv or json)

  • Froomle confirms correct implementation

⚠️ The Published to Froomle PubSub stream integration option is in beta, therefore it involves custom development and timeline. If you are interested in this feature, please contact the Froomle support team.

Upload events using SFTP

For information that is not time-sensitive, you can use file dumps to the Froomle SFTP server, containing many separate entries to be processed at once. Some typical examples are e-mail opens or clicks, historic events or offline purchases. After reading our SFTP reference document, you should have a clear understanding of both how to communicate with the Froomle SFTP and what types of data are a good fit for file dumps.