Skip to main content
All CollectionsOnsiteFloating Widget
Using deep links to open and hide the Loyalty Widget
Using deep links to open and hide the Loyalty Widget

Add deep links to encourage your customers' participation in your Loyalty program

James Dohm avatar
Written by James Dohm
Updated over a week ago


Deep links can be used to open the Floating Widget to specific sections. You can add these links in navigation and menu items, emails, buttons, announcement bars, and anywhere that you would share a normal URL. Using deep links can boost engagement with your customers and encourage new sign-ups!

Video Walkthrough

Deep links available

Deep links are anchor links that send your customers directly to a screen in the Floating Widget rather than the home page. Each anchor can be added at the end of any URL, which is a great way to drive your customers toward your Loyalty Program while they browse your store.

  • #ba-loyalty-home → It opens the front page of the Widget

  • #ba-loyalty-rewards → It opens the section My Rewards

  • #ba-loyalty-ways-to-earn → It opens the section Ways to Earn

  • #ba-loyalty-redeem → It opens the section Ways to Redeem

  • #ba-referral-program → It opens the section Referrals Program

  • #ba-referrals → It opens the section My Referrals

📝 Note: Deep links #ba-loyalty-home, #ba-loyalty-ways-to-earn, and #ba-loyalty-redeem only work with logged-in customers.

Opening the Floating Widget through a deep link

Here are some ways to use these deep links to keep your customers engaged with your Loyalty program.

Open the Widget from a link in your navigation menu

This is a great way to put your Loyalty Program front and center and make it feel more native to your store.

  1. From your Shopify Admin click Online Store.

  2. Click Navigation and select the menu you'd like to edit.

  3. Click add Menu item and add the deep link that you'd like the Widget to open. For example, #ba-loyalty-rewards opens the Widget in the customer's rewards history section.

💡 Pro Tip: When adding a new menu item, only use the deep links (e.g. #ba-loyalty-rewards), not the entire URL (e.g.

Sharing a link to your Loyalty program

Sometimes it's handy to have a link available to share your Loyalty program directly with your customers. Adding a link in an email campaign, your Instagram bio, or a tweet is a popular way to increase engagement on your website.

  1. Copy your website URL.

  2. Add the Loyalty deep link at the end of the URL. The end result should look like this:

  3. Copy the URL and share it away. When your customers visit your website, the Widget will already be opened - magic!

Open the Widget through a page or a button on your website

Opening the Widget through a button is a quick and easy way for customers to access your Loyalty program.

  1. Create your new button according to your theme.

  2. Add the deep link to the href of the button.

  3. The end result should look like this:
    <a class="your-website-button-class" href="#ba-loyalty-home">Open loyalty widget</a>

📝 Note: Deep links can work on <a></a> anchor tags and most menus, but this can vary depending on the theme.

Open the widget through a call-to-action

Add a CTA with a deep link almost anywhere on your site! If you are offering a free product as a reward, the product description is a great place to include a deep link to the Ways to Redeem section.

  1. In your Shopify Admin, go to Products and select the product you're offering.

  2. In the product description, write your CTA. Try something like 'Redeem your points to get this product for free!'

  3. Highlight the text and click Insert link from the options above the description field.

  4. Add the anchor only (e.g. #ba-loyalty-redeem) and click Insert link.

Hiding the Widget on mobile and/or desktop screens

Image 2023-07-03 at 5.03.31 PM

You can use deep links with or without the Widget being hidden on your website. This is a handy way you can preserve valuable real estate on mobile and desktop screens, while still letting your customers engage with your Loyalty program. There are 2 settings on this page that can be used together, or separately.

💡 Pro Tip: Enabling these temporarily is also a great way to test your Loyalty program. Toggle the switches to hide the widget from your customers and use a deep link to take it for a test drive before you launch!

  1. Go to Onsite > Floating Widget.

  2. Click on Hide Widget.

  3. Toggle the switch to ON to hide the Widget:

    1. Option to hide Widget unless deep link is activated - Enable this to hide the Widget button on all screens. This is useful if you would rather open the Widget through a deep link such as

    2. Option to hide Widget unless deep link is activated - Enable this to display the Widget button on large desktop screens only. The button will be hidden on smaller screens (mobiles).

📝 Note: You can add a deep link in your Shopify navigation so that on mobile, your customers can still access your Loyalty program without skipping a beat!

Common questions

Can I close the Floating Widget by clicking the same link I used to open it?

No, as clicking a deep link just opens the Widget. However, there is a close button at the top right corner of the Widget dialog for your customers to quickly close it.

Did this answer your question?