Last updated

Promo Redeem Deep Link – API Integration Guide

A Promo Redeem Deep Link is a mobile hyperlink that:

  • Opens the Hubby app (if installed)
  • Automatically applies and verifies the promo code
  • Removes the need for the user to manually paste or tap "Apply"

This reduces friction between receiving the eSIM benefit and redeeming the promo code.

2. Intended Use

The deep link is designed to minimize user steps in the flow:

Receives benefit → Downloads app → Clicks deep link (the app opens & promo auto-redeems)

It supports the following user states:

Signed-out users

  • App installed but not opened → Opens app & auto-applies promo
  • App installed & previously opened → Applies promo immediately
  • App not installed → Redirects to app store

Signed-in users

  • App already open → Promo applied from Account context
  • App closed → App opens & promo applied

3. Technical Overview

The API returns a deep_link_url field directly in the promo code response for each booking. You do not need to construct the URL manually — simply use the value from the response.

Example response field:

"deep_link_url": "https://hubby-esim.web.app/starter/?promoCode=D9DZ4MTAQM"

Base URL

The deep link URL follows this format:

https://hubby-esim.web.app/starter/?promoCode=

The promoCode value is automatically appended by the API.

4. Channel Compatibility

Mobile (Supported)

  • Mobile email CTA
  • Web button on mobile browser
  • WhatsApp

Desktop (Fallback Behavior)

Desktop is not supported for redemption.

Users clicking from desktop will be redirected to an app download landing page.

For best UX, we recommend:

  • Showing the button only in mobile-targeted communications
  • Or pairing the deep link with a visible copyable promo code

Single Promo Code per User

If one promo code exists:

  • Display a two-step CTA: (1) Download the app, (2) Redeem your eSIM

Multiple Promo Codes (e.g. group bookings)

If multiple promo codes exist:

Recommended structure:

  1. Button using the first promo code (primary traveler)
  2. Below it, display additional promo codes as copyable text for sharing

This ensures:

  • Clean mobile UX
  • No confusion about which code to use
  • Easy forwarding to group members