B Bubbl Docs

Correlation ID

correlation_id is an app-level identifier/reference you provide to identify a user in Bubbl data.

It is attached to device registration and included in SDK network activity so events can be associated with the same user identity.

Behavior

  • Persistent on device once set.
  • Survives app restarts.
  • Cleared when app data is removed (for example uninstall/reinstall) or when you explicitly clear it via SDK method.
  • Can be overridden at any time by setting a new value.

When to Set It

Set correlation_id after login, when your app knows the signed-in user reference.

If the signed-in user changes, set a new value immediately.

Platform Methods

  • Android: see android-sdk/method-reference.md (setCorrelationId, getCorrelationId, clearCorrelationId)
  • iOS: see ios-sdk/method-reference.md (setCorrelationId, getCorrelationId, clearCorrelationId)
  • React Native: see react-native-sdk/method-reference.md (setCorrelationId, getCorrelationId, clearCorrelationId)