Deeplinkly docs

Build your first Deeplinkly integration

Connect a mobile app to Deeplinkly, open users at the right in-app destination, preserve context through install, and attribute the campaign that brought them there.

What Deeplinkly does

A link carries campaign context; the SDK turns that context into an app destination and an attribution record.

Deeplinkly combines deep links, deferred deep links, install attribution, custom events, and campaign link generation. Your app receives a resolved payload from the SDK and decides which screen to open. Deeplinkly records the click and attribution against the project selected in your dashboard.

The SDK does not replace your router

Deeplinkly resolves the link and returns its parameters. Your app remains responsible for mapping those parameters to a screen, route, or navigation action.

Before you start

  • A Deeplinkly account with a project selected in the dashboard.
  • An active API key from that project's App Settings page.
  • Your Android package name or iOS bundle ID and Apple team ID.
  • A test device or emulator and control of the link domain you will configure.

If you do not have a key yet, follow the authentication and API-key guide before installing an SDK.

Choose your SDK

Use the guide that matches the codebase owning your app lifecycle.

The integration flow

Use this order so configuration failures are visible before routing and attribution add more moving parts.

  1. 1. Create or select a project

    A project keeps its platform settings, domains, links, attribution, and API keys together.

  2. 2. Generate an API key

    The SDK uses the active project's key to associate requests and events with the right project.

  3. 3. Install and configure an SDK

    Add the package, put the key in the native platform configuration, and wire link callbacks.

  4. 4. Test a real link

    Verify a cold launch and a warm launch before adding deferred-link and attribution flows.

Next step

Start with authentication. Generate a project key, add it to the native configuration used by your SDK, and verify the SDK can initialize before continuing with links, events, and attribution.

Configure authentication