Skip to main content

Deeplinks

Nightly supports both custom-scheme deeplinks and universal links, allowing seamless communication with other apps and services available on your mobile device.

How does it work​

The link which you send from within your website or an app, granted it is structured correctly, instructs the Nightly app on your device to open the requested url inside the in-app browser, from which you can then connect Nightly with your website and perform various operations. Our app is divided into sections, each being a separate network, therefore you should pass a network property inside the link to open the browser in the network tab of your choice.

note

Nightly currently supports two formats for the same action:

  • nightly://v1 for custom-scheme deeplinks
  • https://nightly.app/v1 for universal links

Both accept the same query parameters.

Nightly supports handling various actions depending on the structure of the link itself. See below.

Opening Nightly App​

To instruct the device to open the Nightly app, use either of the following:

nightly://v1
https://nightly.app/v1

Opening external URL inside Nightly​

To open a requested url inside the Nightly app browser, use a link structured like this.

1
nightly://v1
2
?network=solana
3
&cluster=mainnet
4
&url=https://jup.ag/
1
https://nightly.app/v1
2
?network=solana
3
&cluster=mainnet
4
&url=https://jup.ag/

  1. Prefix - tells the device to transfer the request to Nightly

  2. Network - instructs your Nightly app to open the in-app browser on the specified blockchain

  3. Cluster name - an optional parameter to select a cluster type for the chosen network. Possible values are mainnet, testnet or devnet

  4. Website url - opens the requested url inside the in-app browser


Safari behavior on iOS

If a user taps a https://nightly.app/v1... universal link while already browsing nightly.app in Safari, iOS may keep the user in Safari instead of opening the app. This is expected platform behavior.

For the best experience:

  • use universal links from apps like Discord, Messages, Notes or Mail
  • keep an explicit fallback button that points to nightly://v1?...
  • tell Safari users to tap the native OPEN button when it is shown
info

In the future support for more deeplink types will be implemented into the Nightly app, allowing for operations on the blockchain.