Skip to main content

Getting Started (Quickstart)

This guide walks you through setting up Detour for your app.

1. Create an account​

Sign up at the Detour dashboard and confirm your email.

2. Create or join an organization​

Detour is multi-tenant. An Organization groups apps, links, and users, and has a unique subdomain.

  • While creating an organization, you choose a unique subdomain: yourorg.godetour.link.
  • Invited members can manage apps and links according to role (Owner, Admin, Member).

The organization subdomain is the base for generated deferred links (unless a custom domain is configured for the organization - see the Custom domain for more details).

3. Create your app​

In the dashboard, create a new app by providing App Name.

When the app is created, Detour automatically creates:

  • App ID: unique app identifier used by the SDK configuration.
  • Publishable API Key: active key used by the SDK configuration.
  • Base deferred link: https://<yourorg>.godetour.link/<app_hash> (or custom domain if configured).

The App ID and API Key are required by the SDK configuration.

4. Complete app configuration​

After creating an app, you are redirected to its details view automatically. You can also open it later from the Apps list. In this view, complete three tabs:

  • Your app link is generated automatically and is read-only. You can copy it, open its QR code, and manage metadata, but keep the base hash segment unchanged.
  • Set Redirect URL for web fallback.
  • Configure query forwarding strategy for fallback URL:
    • Don't pass parameters
    • Pass all parameters
    • Pass specific parameters
  • Use Short links for campaign variants with custom path/query parameters.
  • Optionally tune Matching configuration (details in Matching).

App configuration​

Configure iOS and Android separately:

  • iOS:
    • Bundle ID (e.g. com.example.app) — you can find it in Xcode: target settings -> General -> Bundle Identifier.
    • Team ID (10 uppercase alphanumeric characters) — you can find it in Apple Developer account membership details or in Xcode signing settings.
    • App Store ID (numeric) — you can find it in App Store Connect or in your app URL on the App Store (.../id1234567890).
    • Optional: Enable copy link feature
  • Android:
    • Package name (e.g. com.example.app) — you can find it as applicationId in build.gradle (or android.package in Expo config).
    • At least one SHA-256 certificate fingerprint: production or debug — production from Play Console (App integrity), debug from your local debug keystore.

After saving, Detour generates integration snippets with concrete host/path values for app-side setup.

API configuration​

  • Copy Publishable API Key and App ID.
  • You can rotate keys using Generate new key.
  • Rotating revokes the previously active key.

5. Integrate your SDK​

Start with the React Native SDK Installation guide.

You can also check installation guides for other SDKs:

Before testing, make sure you also apply the iOS and Android integration snippets shown in App configuration.

Finally, handle navigation in your app.

6. Test the flow​

  • Make sure at least one platform config is completed (iOS or Android) and Redirect URL is set.
  • Click your link on a real device, it should redirect you to the store.
  • Install and open the app.
  • The SDK calls the match API on a first app open and if matched - returns the link details along with the route.
  • You can also test runtime deep links scenarios - Universal / App Links and custom scheme links. See Universal Links & App Links for details.
See the Usage and Testing & Troubleshooting pages for specific test instructions.

We are Software Mansion.

Hire us