Skip to main content
The Basic Setup
  • Integrate the plugin
  • Add the app to the WaveCX admin
  • Configure the SDK
  • Identify your user
  • Track screen views
  • Reset on logout

Review the Setup Deepdive below

This page covers the integration lifecycle (configure, identify, track, reset) and the Admin Mode/Screen Capture workflow.

Exact package names, install commands, and method signatures differ by platform and version — check with engineering for the current specifics before writing code against this.

System Requirements

  • iOS 15.0 or later (Swift 5.9)
  • Android 7.0 / API level 24 or later (Kotlin, Java 17)
  • A WaveCX organization (tenant)
  • Candescent D3 v6.4 or higher

Platform Support

PlatformStatus
iOS, Android, React NativeSupported — native rendering, no WebView
WebComing Soon
Flutter, Capacitor, IonicNot yet supported
Flutter, Capacitor, and Ionic currently appear as selectable app types in the admin even though they aren’t supported yet.

Setup Deepdive

1

Integrate the plugin

A one-time development step. The plugin is added via standard dependency managers — CocoaPods for iOS, Gradle for Android. Check with engineering for the current package name and version.
2

Add the app to the WaveCX admin

Register the app with its name, bundle ID, and app type. This is what generates the App ID and Environment ID the SDK needs.
3

Configure the SDK

Initialize the SDK as early as possible in your app’s startup, before any screens render. This creates an anonymous session and fetches your default content. You’ll need the App ID and Environment ID from the Admin, plus optionally custom API/analytics base URLs and a debug mode flag.
4

Identify your user

Once someone logs in, call identify(userId, attributes) so Journey Builder can target content to them specifically rather than just anonymously.
Any screen views or events your app fires during identification will not be lost — they’re queued and replayed immediately after identification completes.
5

Track screen views

Report navigation events (trackScreenView / onScreenView / screenViewed, depending on platform). This makes sure screen-based triggers — the ones that start a Tour or show a Callout, actually fire.
6

Reset on logout

Call the reset method when a user logs out. This clears identity, shown-content history, any in-progress Tour state, and frequency tracking. Then, it starts a fresh anonymous session, exactly like a brand-new install.

Setting Up Admin Mode

Admin Mode pairs a real device to the WaveCX admin for live preview of content before publishing, and is used to capture the screens you’ll build Tours, Callouts, and Messages with.
1

Initialize

Tap five times in the top-right corner of the device screen to open the QR scanner.
2

Connect Device

In the WaveCX admin, go to Integrated Content → Journey Builder and click “Connect Device” in the top right.
3

Scan QR code

Scan the QR code shown in the admin. The device pairs over a live WebSocket connection.
4

Capture Screens

Once connected, an icon appears in the bottom-right corner of your device. Tap it to start capturing screens as you navigate the app. Captured screens are sent directly to the admin.
Admin Mode can only target elements that have a stable identifier set: accessibilityIdentifier on iOS, a view tag or resource ID on Android, and testID on React Native. Any view you want to target with a Tour or Callout needs one of these set in your app’s code first.

Screen Capturing

A captured screen is a reference point, not a live dependency. When you capture a screen in Admin Mode, the plugin detects elements based on identifiers your development team has already assigned. The result appears in the admin as a screenshot, with every detected element marked and ready to select.
The captured image is only used for building in the WaveCX admin. When working in the Admin, content attaches to the element itself, which may look different depending on user configuration, recent app updates, or device when being viewed in the live app.

What happens when your app updates:

  • If a screen’s visual design changes (colors, layout, copy) but the targeted element keeps the same identifier, your content will find the correct element and work appropriately.
  • Content only breaks if the element is removed or its identifier changes. Recapture the screen in Admin Mode to re-point your content to the right element.