Integration Guide

Deep Link Integration Guide

Deep link integration with DEPL has four parts: create a workspace subdomain, register your iOS or Android app, create a link with app_params, and handle the incoming URL in your mobile app by fetching the slug data from the API.

Use a DEPL subdomain as the link domain.

Create links from a dashboard or backend API.

Fetch app_params from the mobile app after receiving a slug.

The recommended integration model

DEPL does not require a proprietary mobile SDK. Your app uses native platform link handling, then calls a REST endpoint to retrieve the link payload. This keeps the integration portable across native iOS, native Android, React Native, Flutter, and backend systems.

Backend link creation

Create links from your backend when users create campaigns, invites, referrals, product shares, or onboarding flows. Store the returned deeplink_url in your own system if you need to show it later.

const response = await fetch("https://depl.link/api/deeplink", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.DEPL_API_KEY,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    slug: "product-123",
    app_params: {
      screen: "product",
      product_id: "123"
    }
  })
});

const data = await response.json();
console.log(data.deeplink_url);

Mobile app resolution

When the app opens from https://yourapp.depl.link/product-123, read the last path segment as the slug. Then call GET /api/deeplink?slug=product-123 with your client key and navigate based on app_params.

Common deep link use cases

DEPL links are useful for referral invites, product sharing, creator profiles, limited-time offers, abandoned cart recovery, push notification landing pages, QR codes, email campaigns, and app onboarding flows.

Frequently Asked Questions

What is app_params?

app_params is custom JSON attached to a deep link. Your app uses it to decide which screen to open and which entity or campaign to load.

Can React Native or Flutter use DEPL?

Yes. React Native and Flutter apps can handle Universal Links and App Links through their normal linking APIs, then call the DEPL REST API.

Can DEPL be used only from a backend?

Yes. The API key is intended for server-side link creation. Mobile apps should use the client key only for reading link data.