Send Events and Properties

API reference for logging custom events in session recordings

Track user interactions by logging custom events. Events appear in session timelines and can be used for funnels, filtering, and analytics.

Use Cases

  • Create granular funnels combining Events and Screens
  • Track registration flow drop-offs
  • Measure feature adoption
  • Identify errors in conversion processes

Auto-detected Events: UXCam automatically logs UI Freezes and Rage Taps.


Log Event

Log an event at the current timestamp.

UXCam.logEvent("purchased")
UXCam.logEvent("purchased");
FlutterUxcam.logEvent("purchased");
RNUxcam.logEvent("purchased");
UXCam.LogEvent("purchased");
UXCam.logEvent("purchased");

Log Event with Properties

Add context to events with key-value properties.

UXCam.logEvent("purchased", withProperties: [
    "size": 7,
    "brand": "Nike"
])
Map<String, Object> properties = new HashMap<>();
properties.put("size", 7);
properties.put("brand", "Nike");
UXCam.logEvent("purchased", properties);
FlutterUxcam.logEventWithProperties("purchased", {
    "size": 7,
    "brand": "Nike"
});
RNUxcam.logEvent("purchased", {
    "size": 7,
    "brand": "Nike"
});
// Android
UXCam.LogEvent("purchased", jsonObject);
// iOS
UXCam.LogEvent("purchased", nsObject);
UXCam.logEventWithProperties("purchased", {
    "size": 7,
    "brand": "Nike"
});

API Parameters

ParameterTypeRequiredDescription
eventNameStringYesName to identify the event
propertiesDictionaryNoKey-value pairs (max 20 per event)

Property value types: String and Number only.


Limits and Considerations

LimitValueBehavior
Properties per event20Exceeding logs _UXCam_Overload instead
Property value typesString, NumberOther types may not display correctly

Date Properties

When sending dates as event properties, use these formats:

  • Recommended: UTC format YYYY-MM-DDTHH:MM:SSZ
  • Alternatives: YYYY-MM-DD HH:MM:SS, YYYY/MM/DD, YYYY-MM-DD
  • Unix timestamp: Seconds since 1970 (integer comparison works)

Platform Implementation Guides

PlatformGuide
AndroidEvents
iOSEvents
FlutterEvents
React NativeEvents