Integrations
AlgorithmX is a campaign management and customer data platform (CDP). This guide is for teams integrating AlgorithmX into an application that is already live, with its own authentication, customer data, analytics, notification service, and navigation. The integration connects those existing customer journeys to AlgorithmX audiences and campaigns.
Reuse the application's existing infrastructure. Initialize the SDK from the current application lifecycle, identify customers with the identifier already used by your backend, forward agreed events from existing business hooks, and connect campaign actions to your current deep-link router and business handlers. If the Android application already uses Firebase Cloud Messaging, add AlgorithmX forwarding to the existing messaging service and retain its current notification behavior. If the iOS application already registers for Apple Push Notification service (APNs) tokens, add AlgorithmX forwarding to its existing notification delegate and notification service extension. An existing implementation that supports these responsibilities does not need another Firebase project, messaging service, activity, delegate, extension, or navigation stack. iOS additionally needs an APNs authentication key and push capabilities from your Apple Developer account, which only your team can create.
The work is to add the AlgorithmX-specific connections and agree on the campaign contract. AlgorithmX supplies the SDK artifact and environment configuration; your development team maps the SDK to the application's existing services and routes. Your campaign team uses the customer identifiers, events, destinations, and action names that the application actually supports.
Choose your platform
This section covers Android, iOS, Flutter, and React Native. Each platform has its own guide, based on its SDK and demonstration application. Use the guide for your platform, because initialization, permissions, and callback behavior differ.
| Platform | Documentation status | Next step |
|---|---|---|
| Android | Available; based on the current Android SDK and demo application. | Read the Android integration guide. |
| iOS | Available; based on the current iOS SDK and demo application, including the Apple Developer account setup. | Read the iOS integration guide. |
| Flutter | Available; based on the current Flutter plugin and demo application. | Read the Flutter integration guide. |
| React Native | Available; based on the current React Native package and demo application. | Read the React Native integration guide. |
Map the existing application and agree on the handoff
Before changing the application, confirm the existing integration points below and agree on what AlgorithmX adds. This is an inventory of the current application and the required SDK connections. Each platform guide explains the relevant functions, how to add them to existing code, and how to verify their behavior.
| Requirement | Existing setup to confirm | AlgorithmX-specific work |
|---|---|---|
| SDK and environment | Android application package or iOS bundle IDs, build variants or configurations, supported OS versions, and the existing Application class, AppDelegate, or startup path. | AlgorithmX supplies the SDK artifact and version and the API base URL for each environment. Add the dependency and initialize it in the existing application startup. |
| Customer identity and events | The customer identifier used by the backend, login/session restoration/logout hooks, and the existing business event catalog. | Map identity and session changes to the SDK. Forward the events needed for targeting with agreed names and property types, alongside any existing analytics integration. |
| Deep links and custom actions | The current deep-link router, supported URLs and destinations, authentication gates, business actions, and fallback behavior. | Connect SDK action callbacks to those handlers. Give the campaign team the supported destination URLs, custom action names, and parameter contract. Add a route or action only when the campaign requires one that the application does not already support. |
| Push notifications | Android: the existing Firebase project, messaging service, token lifecycle, notification provider, permission flow, and click handling. iOS: APNs registration, the notification center delegate, any notification service extension, the permission flow, and who administers the Apple Developer account. | Android: coordinate server-side push sending with AlgorithmX for that Firebase project. iOS: enable Push Notifications and background remote notifications, create or reuse an APNs authentication key, and send the key, Key ID, Team ID, bundle IDs, and APNs environments to AlgorithmX. On both, forward the current token to the SDK on every launch, route AlgorithmX messages to its handler, preserve the handling of all other messages, and use the existing notification permission flow. |
| Campaign configuration and validation | Test accounts, current navigation and notification regression checks, supported app states, and release environments. | Agree on test campaigns and payloads. Verify targeting, display, actions, and reporting in foreground, background, and cold-start journeys, and confirm that existing notifications and navigation still work. |
Implement and verify Android
Follow the Android integration guide to add the SDK to your existing app. It shows where each call goes: initialization in your Application, customer identity and events, your existing Firebase token and messaging service, your deep-link router, and custom actions and buttons. Its first section lists what AlgorithmX needs to send through your Firebase project. Test on a real device with both a debug build and your minified release build.
Implement and verify iOS
Follow the iOS integration guide to add the SDK to your existing app. It shows where each call goes: initialization in your AppDelegate, customer identity and events, your existing push token and notification delegate, your deep-link router, custom actions and buttons, and the optional notification service extension. Its first section lists the few Apple Developer account details AlgorithmX needs, such as your APNs key. Test on a physical iPhone with both a debug build and a TestFlight build.
Implement and verify Flutter
Follow the Flutter integration guide to add the plugin to your existing app. A few native lines start the SDK and pass push tokens and notifications to it; everything else happens in Dart: customer identity, events, and navigation from campaign links, custom actions, and buttons. The Apple and Firebase details AlgorithmX needs are the same as for native apps. Test on real Android and iOS devices.
Implement and verify React Native
Follow the React Native integration guide to add the SDK to your existing app. A few native lines start the SDK and pass push tokens and notifications to it; everything else happens in JavaScript: customer identity, events, and navigation from campaign links, custom actions, and buttons. The Apple and Firebase details AlgorithmX needs are the same as for native apps. Test on real Android and iOS devices.
On every platform, connect and verify the application handlers before configuring campaigns to use them. Then run a complete journey with a test customer: identify the customer, send an agreed event, deliver the campaign, interact with it, confirm the destination, and review the resulting interaction data. Include existing notification and navigation journeys in the release checks.