Welcome to the GrowSumo Integration Docs

Here you can find guides, documentation, support and FAQs to get you setup on GrowSumo.

Chat with us by clicking the message bubble in the bottom right if you are having any trouble!

Get Started

Branch.io

Attribute mobile signups to partners

Overview

Integrating Branch.io and GrowSumo allows you to track, attribute, and reward your partners for sending new signups in your mobile application.

Before you begin...

  1. Install Branch.io in your application (Branch Documentation)
  2. Share your Branch Key with GrowSumo support. Do not send us your Branch Secret.
  3. Review the integration diagram below

Step 1. Create Branch 'signup' event

Create a customer event called 'signup', when the user completes your signup process.
The 'signup' custom event should pass the following metadata:

Key
value
Required?

key

Any unique string for this user.
(Example: An existing UUID, or the user's email

yes

email

user's email

no

name

user's name

no

If you do not have Branch installed, please go back up to the "Before you begin" section above.

Follow the proper guide for your platform:

Platform Specific Guides

IOS example

See other code examples in the appropriate guide above.

let metadata: [String: Any] = [

  // Required, and unique per user
  "key": "UUID_1a2b3c",
  // Optional
  "name": "Darth",
  "email":"darth@notaMoon.com"
]

// Fire Event
Branch.getInstance().userCompletedAction(action, withState: metadata)

Step 2. Setup Branch Webhook

Get Growsumo Branch Webhook

Go to your GrowSumo Integration Dashboard and copy the appropriate Branch webhook URL for your environment (Test vs Production).

Create Branch Webhook

Visit your Branch Webhooks Dashboard, and click "Add New Webhook".

Create a new Webhook by clicking `Add webhook.' Then,

  • Paste your GrowSumo Branch webhook URL into the "Send a webhook to"
  • Select "POST" as the request type
  • Select "signup" as the event.

No 'signup' event?
Ensure the 'signup' event has fired to Branch at least once.

Step 3. Testing

Before submitting to the app store please test your work:

  • Build your app
  • Complete your signup flow
  • Check the Branch 'Liveview Events Log' to ensure both the signup event, and all the metadata is being set properly.

Step 4. Follow up with GrowSumo Sucess

If you're not already in contact with and account manager, please send an email to success (at) growsumo.com.

We will guide you through the rest of the process of establishing your GrowSumo-Branch links and testing your integration.