1. Home
  2. Docs
  3. API Connection Guidelines
  4. User Notification
  5. Deep link

Deep link

You can notify your users of a new script by sending them a deep link to Scriptation (e.g. by email). Scriptation will decode this link and redirect the user to the specified folder so they can download the new file. Scriptation will use the previously defined endpoints to retrieve the folder content as well as download the file so any unauthorized access can be denied.

To create a deep link to Scriptation, please use the following URL Scheme:


provider-id(string) Provider id assigned to you by Scriptation’s team.
scrambled-params(string) Scrambled version of the complete path to the desired folder. To construct follow the following steps:

1. Initiate the folder path from the root folder, then concatenate all folder-ids, separating them by a “/”, until you reach your target file.


2. Convert the resulting string to base64 using UTF8 Encoding.
3. Scramble the resulting string using the following dictionary, where the key is the original character and the value is the new character.

For example:

// BASE64: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=
// SCRAMBLED: ABCDEFGHIJKLMabcdefghijklmNOPQRSTUVWXYZnopqrstuvwxyz5678901234-_*

        _scrambling = @{@"N":@"a",