Skip to main content

Testogethr SDK Introduction

Welcome to the Testogethr SDK documentation!

Testogethr allows you to easily distribute your apps for testing, collect feedback, and manage testing campaigns directly within your app.

Quick Start​

The fastest way to get started is by letting AI do the heavy lifting for you. Use our AI Auto-Integration Prompt below to generate the exact code you need for your specific architecture.

🤖 Auto-Integrate with AI

Copy this prompt and paste it into ChatGPT, Claude, or Gemini to instantly get customized integration instructions for your project.

Prompt for your LLM
You are an expert mobile/web developer. I want to integrate the 'Testogethr SDK' into my project.

Here is the technical context of the SDK:
- Language/Framework: Android (Kotlin Multiplatform / Jetpack Compose)
- SDK Version: 1.0.0

Tasks:
1. Ask me about my current project structure.
2. Provide the exact package manager commands to install this SDK.
3. Show me where and how to place the initialization code (`TestogethrSdk.initialize`) in my project.
4. Show me how to update the `AndroidManifest.xml` to listen for Test Sessions via Deep Links (`android:scheme="${applicationId}" android:host="testogethr"`).
5. Provide an example of how to use `TestogethrSdk.get().registerSchema()` to register my `DeclaredEvent` items.
6. Provide an example of how to track a user action using `TestogethrSdk.get().trackEvent("event_name", metadata)` and how to capture the Session Token using `TestogethrSdk.get().startSession(token)`.

Here is some basic context to help you generate the code:
- The core package is "com.testogethr.sdk:core"
- The SDK needs to be initialized as early as possible (e.g. `Application.onCreate`).
- Initialization requires an `sdkAccessToken` and a `TestogethrConfig` object.
- `startSession(token)` must be called when the app is launched via the testogethr deep link.
- `registerSchema` is used to statically define events the app can track.
- `trackEvent` is used throughout the app lifecycle to track testing milestones.

Manual Installation​

If you prefer to install the SDK manually, follow these steps:

  1. Add the dependency to your build.gradle.kts file:

    implementation("com.testogethr.sdk:core:1.0.0")

  2. Initialize the SDK in your Application or Main Activity:

    import android.util.Log
    import com.testogethr.sdk.TestogethrSdk
    import com.testogethr.sdk.TestogethrConfig

    class MyApplication : Application() {
        override fun onCreate() {
            super.onCreate()
            
            TestogethrSdk.initialize(
                sdkAccessToken = "YOUR_SDK_ACCESS_TOKEN",
                config = TestogethrConfig(applicationContext),
                debugLogger = { level, tag, msg, err -> 
                    // You can log these to Logcat or your own analytics service
                    Log.d("Testogethr", "[$level] $tag: $msg", err)
                }
            )
        }
    }

Next, check out the Usage & Advanced Features to understand how to track events and register schemes.