Kotlin Multiplatform Product Analytics installation

1
Install the dependency
Required
Add the PostHog KMP SDK to your shared module's commonMain source set:
shared/build.gradle.kts
kotlin { sourceSets { commonMain.dependencies { implementation("com.posthog:posthog-kmp:0.+") } } }
0.+ resolves to the latest 0.x release. The SDK is a pre-release, so the API can change between minor versions – pin an exact version from Maven Central if you would rather upgrade deliberately. Kotlin/Wasm support requires 0.2.0 or higher.

Configure PostHog

Required

Call PostHog.setup() once, early in your app's lifecycle. The config is shared across every target – only the PostHogContext differs per platform.

Android needs the Application instance, so set PostHog up from your Application class – not from an Activity, whose onCreate re-runs on every recreation (for example, on rotation):

MyApplication.kt
import android.app.Application
import com.posthog.kmp.PostHog
import com.posthog.kmp.PostHogConfig
import com.posthog.kmp.PostHogContext

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        PostHog.setup(
            config = PostHogConfig(
                apiKey = "<ph_project_token>",
                host = "https://us.i.posthog.com",
            ),
            context = PostHogContext(this),
        )
    }
}

android/src/main/AndroidManifest.xml
<application android:name=".MyApplication" ...>

On iOS, use the no-argument PostHogContext():

MainViewController.kt
import com.posthog.kmp.PostHog
import com.posthog.kmp.PostHogConfig
import com.posthog.kmp.PostHogContext

fun MainViewController() = ComposeUIViewController {
    LaunchedEffect(Unit) {
        PostHog.setup(
            config = PostHogConfig(
                apiKey = "<ph_project_token>",
                host = "https://us.i.posthog.com",
            ),
            context = PostHogContext(),
        )
    }
    App()
}

On the web (Kotlin/JS and Kotlin/Wasm), use the no-argument PostHogContext():

main.kt
import com.posthog.kmp.PostHog
import com.posthog.kmp.PostHogConfig
import com.posthog.kmp.PostHogContext

fun main() {
    PostHog.setup(
        config = PostHogConfig(
            apiKey = "<ph_project_token>",
            host = "https://us.i.posthog.com",
        ),
        context = PostHogContext(),
    )
}

On the JVM – for example, a Compose Multiplatform desktop app – use the no-argument PostHogContext():

main.kt
import com.posthog.kmp.PostHog
import com.posthog.kmp.PostHogConfig
import com.posthog.kmp.PostHogContext

fun main() = application {
    PostHog.setup(
        config = PostHogConfig(
            apiKey = "<ph_project_token>",
            host = "https://us.i.posthog.com",
        ),
        context = PostHogContext(),
    )
    // ...
}

Send events

Recommended

Once installed, PostHog automatically captures app lifecycle events on Android and iOS. Send an event manually from shared code to test your integration:

Kotlin
import com.posthog.kmp.PostHog

PostHog.capture(
    event = "button_clicked",
    properties = mapOf(
        "button_name" to "signup"
    )
)

Next steps

Recommended

Now that you're capturing events, continue with the resources below to learn what else Product Analytics enables within the PostHog platform.

Resource	Description
Capturing events	Learn how to capture custom events beyond autocapture
Identifying users	Associate events with specific users
Creating insights	Build trends, funnels, and retention charts
Group analytics	Track events at the company or account level

Kotlin Multiplatform Product Analytics installation

Install the dependency

Configure PostHog

Send events

Next steps

Still have questions?

Was this page useful?