Documentation

Quickstart

Create an account, add an app, configure iOS and make your first authenticated API call. About ten minutes.

Live and test environments

How the two environments are kept apart, and why it is enforced by the shape of an API key rather than by a filter.

iOS universal links setup

What a universal link is, the association file iOS fetches, the entitlement your app needs, and how to handle the incoming URL.

Android setup

App Links, the assetlinks.json file Google fetches, why you need every signing certificate rather than one, and the deterministic install match that iOS cannot do.

Capacitor quickstart

From nothing to a working deep link, in five lines and about ten minutes. Written for somebody who has never used us.

Deferred matching, and how well it works

What happens when somebody installs your app from a link — and the measured match and false positive rates, including the bad case.

Clipboard matching

Exact deferred attribution, at the cost of a visible paste banner on iOS. What your users see, and what it is worth.

When it does not work

Every failure state, what it means, and what to do about it. Including the Apple caching delay that makes a correct setup look broken for up to 24 hours.

What to declare in your privacy manifest

Exactly what the SDK collects, what that means for your App Store submission, and how to handle an erasure request.

Versioning and the stability guarantee

What we will never change inside a major version, how long a version is supported, and how you find out. The promise a shipped app depends on.

Cordova, React Native and the web

The same package on the other three platforms, and an honest note about which of them we have actually run.

API reference

Authentication, the endpoints that exist today, and the error responses you should expect.

Creating and managing linksNot written

Creating, updating, archiving and listing links over the API.

Why not yet: The endpoints exist and work. This page is not written yet, and an index that claimed otherwise would be worse than an honest gap.

Webhooks

Being told when something happens, rather than polling for it. Signature verification with working code, the retry schedule, and the replayable delivery log.

Teams, roles and invitations

Owner, admin and member; what each may do; and how invitations work.