Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.linkrunner.io/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through the four steps every Linkrunner integration follows. Each step links out to platform-specific instructions when you need them.

​
1. Create a Project & Get Your Token

  1. Sign in to the Linkrunner Dashboard.
  2. Create a new project (or open an existing one).
  3. Copy your Project Token from Dashboard → Documentation.
  4. (Optional, recommended for production) Grab your Secret Key and Key ID from Dashboard → Settings → SDK Signing to enable request signing.

​
2. Install the SDK

Pick your platform and follow the install steps in the corresponding SDK guide. 
npm install rn-linkrunner
# or
yarn add rn-linkrunner
Full React Native guide →

​
3. Initialize the SDK (Required)

Call init as early as possible in your app’s startup — typically in your root component, Application class, or AppDelegate. Pass the optional secretKey and keyId if you set them up in step 1. 
import linkrunner from "rn-linkrunner";

await linkrunner.init(
    "YOUR_PROJECT_TOKEN",
    "YOUR_SECRET_KEY", // Optional
    "YOUR_KEY_ID",     // Optional
);

​
4. Identify the User (Required)

Call signup once, as soon as the user is identified — whether through signup or login. This is what ties the install (and any future events) to a user identifier and powers revenue and lifecycle attribution. 
await linkrunner.signup({
    user_data: {
        id: "user_123",        // Required
        name: "Jane Doe",      // Optional
        email: "jane@example.com",
        phone: "9876543210",
        is_first_time_user: true,
    },
});
signup is required. setUserData is optional and is not a replacement for signup — call it later only when additional user details become available (e.g., the user adds a phone or completes their profile after the initial signup).
To unlock remarketing and deferred deep linking, forward incoming deep link URLs to Linkrunner. Each SDK exposes a handleDeeplink (or equivalent) method — see the SDK guide for the cold-start and warm-start hooks specific to your platform.

Deep Linking Setup

Configure universal links and app links for your domain.

Deferred Deep Linking

Route brand-new installs to the right in-app screen.

​
6. Verify Your Setup

Run the integration test suite

End-to-end checks for clicks, installs, events, and postbacks.

Troubleshoot attribution

Common issues and how to debug them.

​
What to Build Next

Connect Ad Networks

Hook up Meta, Google, TikTok, Snapchat, or LinkedIn.

Track Revenue

Send purchases and tie them back to acquisition source.

Forward to Analytics

Pipe attribution into Mixpanel, Amplitude, PostHog, GA4, and more.

Build Remarketing Audiences

Re-engage users with on-device event-based segments.

​
Need Help?

Email support@linkrunner.io — we typically respond within a few hours during business hours.