API Reference

Deep Link Configuration

This document will provide you insights on how to configure the deep link for the referral campaign using Firebase and Branch.io

1. Firebase

1.1 Setting up deep link in Firebase

  1. Login to Firebase
  2. Go to Dynamic link section
  3. Click on Add URL Prefix
  4. Enter the domain name you want to create. From the drop-down, select a Google-Provided domains Eg: .page.link
  5. Share the WebAPI key with Rehook from your firebase console. It can be found in path
    Settings > General> Web API Key

1.2 Integrating Firebase with Rehook

Please share the following details with Rehook

  1. Website/default URL (mandatory) : To redirect the user if URL is opened from outside android or ios ecosystem
  2. API Key (mandatory): Firebase web API key
  3. URL Prefix (mandatory)
  4. Playstore URL (optional)
  5. Appstore URL (optional)
  6. Android Package Name (optional)
  7. IOS Bundle ID (optional)
  8. IOS Appstore ID (optional)

Above details to be configured on Rehook dashboard:

  1. Click on configuration from side of admin panel
  2. Click on Deep link configuration tab
  3. Click on + Add New CTA found against your application name
  4. Select the Deep link provider as FIREBASE
  5. Fill in the mandantory details in the deep link configuration modal
Deep link configuration tab

Deep link configuration tab

1.3 Processing referral link from devices

Please refer to the following documentation for receiving and processing the referral links

  1. Android: https://firebase.google.com/docs/dynamic-links/android/receive
  2. iOS: https://firebase.google.com/docs/dynamic-links/ios/receive

The referlink that you extract will be of the format https:///?userId=<referrer'sUserId>&referralCode=