Documentation navigation
Documentation

Send your visitors a link with a custom URL scheme to your app

Do you have an app and would like to send your visitors a link that would open it or route them to a specific page on your app? You can use Chatlio's Custom URL Scheme feature to "safelist" your app's custom URL.

For example, let's say you and your customers usually navigate to your app with the URL myapp://mycompany.com/support. Out of the box, if you send one of these links in Slack to one of your visitors, Chatlio will strip out the link for security reasons because the link does not have a http or https protocol.

In order to tell Chatlio to allow your app URL, you have to use Chatlio's JavaScript Widget API and define a customUrlScheme value in the _chatlio.configure() method. Then when any app link you post in Slack that matches your scheme will then get routed to the visitor successfully.

Here is how to enable your custom app URL scheme:

  1. Add the following code to your website: 
    document.addEventListener('chatlio.ready', function(e) {
    _chatlio.configure({
        "customUrlScheme": "myapp",
    });
});

    NOTE: the customUrlScheme will be the first part of your app URL before the ://. For example, you would use myapp as your customUrlScheme in the myapp://mycompany.com/support example URL.

    NOTE: If you are already using the _chatlio.configure() method on your site, you just have to add the "customUrlScheme": "myapp" part to your existing code.

  2. And that's it! Now you will be able to send your app links to your visitors.