Background

Our server to server integration gives you full control of all data transfer in and out of your organisation without compromising user experience by utilising our suite of open source UX Helper libraries.

Your backend facilitates the communication with Rokt, the UX Helpers provide a seamless user experience and your users get to see the most relevant placements at the right moment within their journey.

Not looking for server to server? Check out our streamlined suite of SDKs for Web, iOS, Android, Flutter and React Native.

End to end

The end to end experience can be broken into two categories: Experiences and Events.

Experiences

Experiences are the building blocks for Rokt to show relevant placements to your users. The responses for these include everything you need to render beautiful user interfaces and facilitate the users interactions. You can find more information about experiences in the backend section below.

Events

Events are the signals that are produced by the experiences and UX Helper to help facilitate a seamless experience. These include things like the views, dismissals and opening of content by a user. Events come in two forms: Platform events and UX Events with more details about each below.

Platform events

Platform events facilitate the integration with Rokt and are required to be sent back to the Rokt backend for processing. You can find more information about events in the backend section below.

Using the Rokt UX Helper you simply need to add the platform events listener and forward the generated payload to Rokt.

UX Events

UX events help facilitate the user journey of the app, are consumed within the app only and do not need to be sent to any external services. For example when a user selects a URL the UX Helper will emit an event called OpenUrl that the partner app should consume and open the relevant type of browser. You can find more information in the frontend section below.

Integration

For end to end integration you need to implement both the backend and frontend within your ecosystem.

Backend

For the backend integration you need to implement two API integrations and relevant endpoints for your app communication. For the communication with Rokt you must implement both the experiences and events APIs:

• Experiences API documentation
• Events API documentation

Frontend

Rokt has developed a range of lightweight UX Helper libraries to ensure your customers get the richest and most relevant experience.

You can find documentation for each library here: iOS, Android and Web.

Our suite of frontend libraries are extremely flexible and support a wide gamut of technologies:

• Android: Java, Kotlin, XML and Jetpack Compose
• iOS: Swift, SwiftUI and UIKit

Support

If you have any questions, reach out to support@rokt.com. We'll be happy to assist you.