4. Outcome Events API

What are Outcome Events?

While standard Events capture raw, generic point-in-time telemetry, Outcome Events are specialized data points explicitly labelled with a result.

By attaching an outcome label to an event, you train the telemetry model to recognize patterns leading up to actions you want to encourage (e.g., completing a purchase) or discourage (e.g., abandoning a flow).

The API Surface

The SDK provides a dedicated method for outcome events. It requires an event name, an outcome label, and a data dictionary describing the context of that outcome.

1. Sending Outcome Events

Call sendOutcomeEvent(_:with:and:) to label a conversion result immediately as it resolves. Like standard events, this call is synchronous from your call site; the SDK encodes and uploads the payload on a background task.

import NX10CoreSDK

func handlePurchaseResult(wasSuccessful: Bool, packId: String, price: Double) {
    let eventData: [String: Any] = [
        "pack_id": packId,
        "price_usd": price
    ]

    if wasSuccessful {
        NX10Core.shared.events.sendOutcomeEvent(
            "iap_funnel",
            with: "converted",
            and: eventData
        )
    } else {
        NX10Core.shared.events.sendOutcomeEvent(
            "iap_funnel",
            with: "unconverted",
            and: eventData
        )
    }
}