Button Links Integration on
Mobile Web

Button Links Integration

Button Links allows you to create a link that utilizes Button's attribution system. These links will have the form:

https://r.bttn.io?btn_url=https%3A%2F%2Fwww.example.com&btn_ref=org-YYY

Button Links accept the following query string parameters. All links must only contain ASCII characters and have properly encoded query strings.

  • btn_url (required): The target Merchant URL.
  • btn_ref (required): Your Button Organization ID (always starts with the prefix org-). This can be found in your Button dashboard.
  • btn_pub_user (optional): Your user’s unique identifier. This value will be passed back to you in webhook requests associated with any downstream Merchant activity such as orders or app-installs. Must be under 256 characters (decoded). Note: Loyalty Publishers must include this value in order to know which user to reward.
  • btn_pub_ref (optional): A Publisher reference value (e.g. click ID, campaign ID). This value will be passed back to you in webhook requests associated with any downstream Merchant activity such as orders or app-installs. Must be under 512 characters (decoded).
  • btn_desktop_url (optional): A URL to redirect to if the user is on desktop. Leverage this parameter if you have a desktop network affiliate link you would like to use, otherwise exclude this parameter.
  • btn_fallback_exp (optional): The desired fallback behavior if the Merchant app is not installed. This declares a preference and may not be respected for a variety of reasons, including the Merchant only supporting certain flows. If not declared, we will default to the interstitial experience. Field values include:
    • interstitial: Show a merchant-branded interstitial to the user to select which fallback they would prefer: appstore or web.
    • appstore: Route user to the platform's app store.
    • web: Route user to the Merchant's website.