Get started with Detour

Add the Detour SDK to your project using your preferred package manager.

npm install @swmansion/react-native-detour

npx expo install expo-application expo-clipboard expo-constants expo-localization @react-native-async-storage/async-storage expo-device

Initialise the SDK with your App ID and API Key. You'll copy these from the Detour dashboard in the next step.

import { type Config } from '@swmansion/react-native-detour';

export const detourConfig: Config = {
  apiKey: process.env.EXPO_PUBLIC_DETOUR_API_KEY!,
  appID: process.env.EXPO_PUBLIC_DETOUR_APP_ID!,
  shouldUseClipboard: true,
  linkProcessingMode: 'deferred-only',
};

import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour';
import { detourConfig } from '@/detour.config';

export const handleNativeIntent = createDetourNativeIntentHandler(detourConfig);

import { DetourProvider } from '@swmansion/react-native-detour';
import { Stack } from 'expo-router';
import { detourConfig } from '@/detour.config';

export default function RootLayout() {
  return (
    <DetourProvider config={detourConfig}>
      <Stack />
    </DetourProvider>
  );
}

Detour routes links through your workspace subdomain. An App ID and API Key bind the SDK to your account — you'll need both before your first deferred link can resolve.

1. 01

   Create your account

   Sign up at the Detour dashboard and confirm your email address.

   Open dashboard
2. 02

   Create an organisation

   Choose a unique subdomain — this becomes the base for all your deferred links (e.g. yourorg.godetour.link).

   Or connect a custom domain

3. 03

   Create your app

   Add a new app in the dashboard. Detour will generate an App ID, a Publishable API Key, and your base deferred link automatically.

4. 04

   Copy your credentials

   Go to the API Configuration tab and copy your Publishable API Key and App ID — you'll need them in the Configure step above.