Format

A preview link has the following format: https://<subdomain>.wwk.link/<code>.

Example

An example of the Preview Link page for the Usage app, available at https://usage.wwk.link/NMB231.

Simple

With Deep Links

Setting Up

To configure the Preview Link feature, go to its tab on the sidebar.

Subdomain

Subdomain is required to enable the Preview Link feature.

Subdomain can be set only once.

Upload app icon.

Name

Name of the app.

Description

Short description of the app.

Set the link to where your app is available. This can be a link to the App Store or website. See Deep Links for more configuration options.

Deep links are used to open the app directly from the Preview Link page.

Configure a deep link for each platform where your app is available, or set a single deep link that works across all platforms.

Enter $code as part of your deep link url to receive a referral code value.

For example, myapp://open/referral?code=$code will result in myapp://open/referral?code=XYZ123, when the referral code is XYZ123.

You are responsible for setting up the deep links handling in your app. When receiving a deep link, you can present a view, claim the received referral code, or implement any other functionality that suits your app’s needs.

Access

Swift SDK

The Preview Link value is available on the User object as the previewLink property.

Get it from the singleton instance:

let previewLink = Referrals.shared.user?.previewLink

Or in a SwiftUI view from the observable object:

@State var referralsObservableObject = Referrals.shared.observableObject

...

Text(self.referralsObservableObject.user?.previewLink ?? "-")

Learn more about Swift SDK.

TypeScript SDK

The Preview Link value is available on the user object as the preview_link property.

const user = await winwinkit.fetchUser({appUserId: "<app-user-id>"});
const previewLink = user?.preview_link;

REST API

The Preview Link value is part of the User object:

{
  "data": {
    "user": {
      "app_user_id": "821fae4b5-1a2d-4c1e-9152-5297086a161c",
      "code": "XYZ123",
      "preview_link": "https://example.wwk.link/XYZ123",
      ...
    }
  }
}

Format

A preview link has the following format: https://<subdomain>.wwk.link/<code>.

Example

An example of the Preview Link page for the Usage app, available at https://usage.wwk.link/NMB231.

Simple

With Deep Links

Setting Up

To configure the Preview Link feature, go to its tab on the sidebar.

Subdomain

Subdomain is required to enable the Preview Link feature.

Subdomain can be set only once.

Upload app icon.

Name

Name of the app.

Description

Short description of the app.

Set the link to where your app is available. This can be a link to the App Store or website. See Deep Links for more configuration options.

Deep links are used to open the app directly from the Preview Link page.

Configure a deep link for each platform where your app is available, or set a single deep link that works across all platforms.

Enter $code as part of your deep link url to receive a referral code value.

For example, myapp://open/referral?code=$code will result in myapp://open/referral?code=XYZ123, when the referral code is XYZ123.

You are responsible for setting up the deep links handling in your app. When receiving a deep link, you can present a view, claim the received referral code, or implement any other functionality that suits your app’s needs.

Access

Swift SDK

The Preview Link value is available on the User object as the previewLink property.

Get it from the singleton instance:

let previewLink = Referrals.shared.user?.previewLink

Or in a SwiftUI view from the observable object:

@State var referralsObservableObject = Referrals.shared.observableObject

...

Text(self.referralsObservableObject.user?.previewLink ?? "-")

Learn more about Swift SDK.

TypeScript SDK

The Preview Link value is available on the user object as the preview_link property.

const user = await winwinkit.fetchUser({appUserId: "<app-user-id>"});
const previewLink = user?.preview_link;

REST API

The Preview Link value is part of the User object:

{
  "data": {
    "user": {
      "app_user_id": "821fae4b5-1a2d-4c1e-9152-5297086a161c",
      "code": "XYZ123",
      "preview_link": "https://example.wwk.link/XYZ123",
      ...
    }
  }
}