Deep links

A deep link opens a mini app inside the shell (or brings it to the front), optionally at a route inside it:

xyz.cskn.apps://open/<slug>[/<path>][?<query>]     mobile
cskn-apps://open/<slug>[/<path>][?<query>]         desktop

For example, xyz.cskn.apps://open/music/playlist/42?ref=share opens the Music app at /playlist/42?ref=share.

Following links in your router

useDeepLink starts with the link the app was launched with and updates whenever a new one arrives while the app is open. Drive your router from it:

import { useEffect } from 'react';
import { useNavigate } from 'react-router-dom';
import { useDeepLink } from '@cskn/sdk';

function DeepLinkRouter() {
  const link = useDeepLink(); // { path, url, params } | null
  const navigate = useNavigate();

  useEffect(() => {
    if (link) navigate(link.path);
  }, [link, navigate]);

  return null;
}

A link reaches your app in one of two ways:

Launch link. When a link opens the app, the path is already part of the URL the page boots with. No event is sent. Read it with getInitialDeepLink().
Runtime link. When the app is already open, the shell sends a deeplink event so your router can navigate without reloading. Subscribe with onDeepLink(cb).

import { getInitialDeepLink, onDeepLink } from '@cskn/sdk';

const initial = await getInitialDeepLink();           // { path, url, params } | null
const unsubscribe = onDeepLink(({ path }) => router.navigate(path));

Opening another app

import { openDeepLink } from '@cskn/sdk';

openDeepLink({ slug: 'store', path: '/product/9' });        // another app: user confirms
openDeepLink({ url: 'https://store.cskn.app/product/9' });   // same, by URL
openDeepLink({ path: '/settings' });                         // inside this app: no prompt

string

Another app to open or bring to the front.

string

A full cskn.app URL instead of a slug.

string

The route to open. Alone, it navigates inside the current app.

Record<string, string>

Query parameters.

Opening a different app always shows the user a confirmation (“X wants to open Y”). Nothing happens if they decline, so an app cannot move the user to another app without their consent. Navigating within your own app needs no confirmation.

Surfaces

Surface	Behavior
Mobile, desktop	Full support, from the OS and from other apps.
TV	App-to-app links through the SDK. OS launch links are not supported yet.
Browser	`getInitialDeepLink` and `useDeepLink` return the current location; `openDeepLink` does a normal navigation. The same code works on a user page.

Overview

Platform API

Native features

Profile integration

Reference

Following links in your router

Opening another app

Surfaces

​Following links in your router

​Opening another app

​Surfaces

Following links in your router

Opening another app

Surfaces