Quickstart

This walks you from a new account to a link that opens your app on a phone. It takes about fifteen minutes if your app already exists. Everything is done in the test environment first.

1. Create a project#

1. Sign up at the dashboard and verify your email address (a live environment stays locked until you do).
2. Create an organization and a project. The project slug becomes your link host: {slug}.becklinks.com for live links and {slug}-test.becklinks.com for test links. See Core concepts.

2. Describe your apps#

Open Applications and fill in the part that applies:

• Android: package name, the SHA-256 fingerprint of the key that signs the installed app, and the Play Store URL. See Android.
• iOS: bundle ID, Apple Team ID and the App Store ID. See iOS.
• Web: the page desktop visitors and phones without your app should see.

Beck Links then serves the two files the platforms check, apple-app-site-association and assetlinks.json, on your link hosts. The dashboard's Setup check tells you what is still missing.

3. Get a publishable key#

Under SDK and keys, copy the publishable key of the test environment (pk_test_…). It is safe in an app. Secret keys (sk_test_…) are for your servers only.

4. Add the SDK to your Flutter app#

flutter pub add becklinks_flutter

Do the platform setup (Android, iOS), then configure the SDK once and handle links in one place:

import 'package:becklinks_flutter/becklinks_flutter.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await BeckLink.instance.configure(apiKey: 'pk_test_YOUR_KEY');
  BeckLink.instance.onLink.listen((link) {
    // link.path is the screen to open, for example /product/123
  });
  runApp(const MyApp());
}

More in Install and initialise and Handle links in your app.

5. Create a link#

In the dashboard open Links, then Create link, and set the in-app route, for example /product/123. Or through the API:

curl -X POST https://api.becklinks.com/v1/links \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"deep_link_path":"/product/123","path":"summer"}'

6. Verify it works#

1. Open the test link on a phone, from Notes or Messages (a link typed into the browser's address bar never opens an app on iOS).
2. The app opens on the linked screen and your onLink listener receives a LinkEvent with matchMethod: app_link and confidence: certain.
3. In the dashboard, Link Tester and the link's Performance tab show the click.

If the browser opens instead of the app, go to Testing and debugging. When everything works in test, repeat the setup for live with Going live.