Payghaam
Get started

Documentation

Android SDK (Kotlin)

Native Kotlin library for FCM push, identity, tags, and events.

Install

Add the sdks/android/payghaam module to your Gradle project, apply Google services, and include google-services.json.

kotlin
dependencies {
    implementation(project(":payghaam"))
}

Quick start

kotlin
Payghaam.initialize(
    applicationContext,
    PayghaamConfig(
        appId = "YOUR_PROJECT_ID",
        apiKey = "ek_client_...",
        baseUrl = "https://api.yourhost.com",
    ),
)

lifecycleScope.launch {
    Payghaam.login("user-123")
    Payghaam.onPushPermissionResult(granted = true)
    Payghaam.trackEvent("app_open")
}

Push

The SDK includes PayghaamFirebaseMessagingService for token refresh and data message receipts. Upload the FCM service account JSON in the dashboard — see Push configuration.

Android 13+

Request POST_NOTIFICATIONS at runtime, then call Payghaam.onPushPermissionResult(granted).

lightbulb

Tip

Full API reference lives in sdks/android/README.md in the repo.