Skip to main content
Deep links allow you to open the rewards panel to specific pages programatically. This allows you to display relevant content to your customers in specific scenarios. Here are some examples of what you can do with the deep link system:
  • Show a customer how they can earn more points when they click a button on your site
  • Show a customer their referral link
  • Show a customer how they can spend points
The following deep links are currently supported and available for general use:
Deep linkDescription
homeIf a customer is currently logged-in, displays their rewards program status based on which programs the account has setup (points, referrals, VIP).If no customer is currently logged-in, displays general reward program information.
points_activity_rulesDisplays a list of ways that a customer can earn points.
points_product:{id}If a customer is currently logged in, displays the redemption screen for the points product whose ID is provided (replace {id} with a valid points product ID). If no customer is currently logged-in, displays the list of rewards that customers can redeem their points for.
points_productsDisplays a list of rewards that a customer can redeem their points for.
referral_program_detailsDisplays information about the referral program. If a customer is currently logged-in, this includes their referral URL.
There are 4 different ways you can use the deep link system.

​
Query parameter

https://store.example.com/?smile_deep_link=points_products

​
JavaScript

SmileUI.openPanel({ deep_link: "points_products" });

​
HTML attribute

<a href="#" data-smile-deep-link="points_products">Redeem your points!</a>

​
Anchor tag

This method differs slightly from the others. For this method, the deep links are prefixed with smile- and are dasherized instead of underscored. For example, the points_products deep link becomes smile-points-products. 
https://store.example.com/#smile-points-products
Anchor tags should only be used when you want to open the rewards panel from a page that the user already has open. If you’d like to link to a different page AND open the rewards panel once the page has loaded, you should use the query parameter approach instead. Links included in emails should also use the query parameter approach.