Sending Events

How To Track an Event

Call the track method on EngagementCloud.event to track an event of a given type.

Android

EngagementCloud.event.track(event)

Kotlin Multiplatform

EngagementCloud.event.track(event)

iOS

await EngagementCloud.shared.event.track(event: event)

Web

await window.EngagementCloud.event.track(event);

The track method accepts different event types. On Web, each event must include a type property to differentiate between them.

CustomEvent

These events trigger in-app campaigns and automations, and can be used for segmentation, personalization, and analytics in SAP Engagement Cloud.

• event is a CustomEvent with a mandatory name (string) and optional attributes (Map<String, String>).

Android

val event = CustomEvent(name, attributes)

Kotlin Multiplatform

val event = CustomEvent(name, attributes)

iOS

let event = CustomEvent(name: <event-name>, attributes: <attributes>)

Web

const event = { type: "custom", name: name, attributes: {"key1": "value1"} }

To trigger in-app campaigns or automation programs, the name of the custom event must match the trigger configured for the campaign.

NavigateEvent

The NavigateEvent tracks navigation to a specific location, such as a URL or screen name. It accepts a single location parameter (String).

Android

val event = NavigateEvent(location = "home_screen")
EngagementCloud.event.track(event)

Kotlin Multiplatform

val event = NavigateEvent(location = "home_screen")
EngagementCloud.event.track(event)

iOS

let event = NavigateEvent(location: "home_screen")
await EngagementCloud.shared.event.track(event: event)

Web

const event = { type: "navigate", location: "https://www.sap.com" }
await window.EngagementCloud.event.track(event);

Error Handling

Android

EngagementCloud.event.track(CustomEvent("product_view", mapOf("sku" to sku)))
    .onFailure { e -> logger.error("Event failed", e) }

Kotlin Multiplatform

EngagementCloud.event.track(CustomEvent("product_view", mapOf("sku" to sku)))
    .onFailure { e -> logger.error("Event failed", e) }

iOS

do {
    try await EngagementCloud.shared.event.track(
        event: CustomEvent(name: "product_view", attributes: ["sku": sku])
    )
} catch {
    print(error)
}

Web

try {
    await window.EngagementCloud.event.track(
        { type: 'custom', name: 'product_view', attributes: { sku } }
    );
} catch (e) {
    console.error(e);
}

Testing Strategy

Wrap tracking in an interface, for example AnalyticsTracker, so unit tests can assert calls without hitting the SDK.