Branch

Setting up Branch Deeplinks and integrating the same with CustomerGlu

  • Sign in to your branch.io dashboard

  • Enter your preferred domain name & click Next

  • Fill the required details about your website iOS/Android app etc. and click Next

  • You can now see your first deep link automatically, generated by BranchIO, click on next and it will redirect you to the dashboard

  • Click on the Configuration on left sidebar and scroll down to link domain section & copy the link under Default Link Domain & share it with CustomerGlu

  • Click on the Account Settings on left sidebar and under Profile tab in Branch Key and Secret section, copy the key & share it with CustomerGlu

  • Share following with CustomerGlu:

    • branchKey

    • og_title: for meta/preview //optional

    • og_description: for meta/preview //optional

    • og_image_url: for meta/preview //optional

    • og_url: for meta/preview //optional

    • desktop_url: Website Link

    • ios_url: Appstore Link

    • android_url: playStore Link

Please refer to the following documentation for receiving and processing the referral links Android: https://help.branch.io/developers-hub/docs/android-advanced-features#read-deep-link iOS: https://help.branch.io/developers-hub/docs/ios-advanced-features#read-deep-link The referral link encodes the userId and referralCode information and the same can be extracted from the link to be passed on to CustomerGlu while registering a new user.

referredBy

Store the referrer userId information and pass it as referredBy property in the device registration call for the new user:

{
    "userId": "<new-user-Id>",
    "deviceId": "asd",
    "deviceName": "TestDevice",
    "deviceType": "android",
    "writeKey": "write-key",
    "firebaseToken": "firebase-token",
    "referredBy": "referrerUserId"
}

Note: On installation where there is no referrer, you need not send referredBy property in the call

referralCode

Store the referral code information and pass it as referralCode property in the device registration call for the new user:

{
    "userId": "<new-user-Id>",
    "deviceId": "asd",
    "deviceName": "TestDevice",
    "deviceType": "android",
    "writeKey": "write-key",
    "firebaseToken": "firebase-token",
    "referralCode": "ABC-123"
}

Note: On installation where there is no referrer, you need not send referralCode property in the call

Last updated