Branch
Branch is a platform to increase mobile revenue with enterprise-grade links built to acquire, engage, and measure across all devices, channels, and platforms.
This integration works in two ways.
Once you successfully configured Branch integration, Apphud will receive attribution data from it. You can view this data on user's page:
Apphud can also send all subscription events to Branch. So you could view these events in Branch dashboard and Branch could pass this data to their partners. This will help to measure efficiency of your ad campaigns.
Integrate Branch SDK into your iOS app.
At Apphud go to "Integrations" section and add Branch:
Copy Webhook URL:
Sign in to Branch, go to "Data Feeds" in "Data Import & Export" section. Open "Webhooks" and add new webhook:
Paste Webhook URL copied from Apphud to "Send a webhook to" field. Make sure you selected POST option and INSTALL event:
Create one more Branch webhook using the same Webhook URL, but select OPEN event instead of INSTALL:
As a result, you should have 2 webhooks configured in Branch: for INSTALL and OPEN events.
Make sure you are in LIVE environment in Branch.
Open "Account Settings" in Branch and copy"Branch Key" :
Paste copied key into "Branch live key" field in integration settings:
Return to Branch end switch to TEST environment.
Copy test Branch Key and paste into "Branch test key" field in Apphud:
You can enter your custom event names or disable some.
Please, use only lower-case alpha-numeric characters (a-z and 0-9) for your in-app event names.
Enable integration:
Save changes:
While configuring integration you can also choose between sending revenue as sales or proceeds (without Apple 15%-30% commission).
You can read more how Apple calculates commission here.
In order to receive Branch attribution data from Facebook, you should accept Facebook’s "Advanced Mobile Measurement Agreement" using this link.
This is a list of all possible events and their parameters that are being sent to Branch.
Event name: START_TRIAL
Default event alias: apphud_trial_started
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1unit: Stringunits_count: Integer
Event name: PURCHASE
Default event alias: apphud_trial_converted
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1revenue: Floatcurrency: String
Default event name and alias: apphud_trial_expired
Parameters:
product_id: Stringreason: String
Event name: PURCHASE
Default event alias: apphud_intro_started
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1revenue: Floatcurrency: Stringoffer_type: Stringunit: Stringunits_count: Integer
Event name: PURCHASE
Default event alias: apphud_intro_renewed
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1revenue: Floatcurrency: Stringoffer_type: Stringunit: Stringunits_count: Integer
Event name: PURCHASE
Default event alias: apphud_intro_converted
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1revenue: Floatcurrency: Stringoffer_type: String
Default event name and alias: apphud_intro_expired
Parameters:
product_id: Stringreason: Stringoffer_type: String
Event name: PURCHASE
Default event alias: apphud_intro_refunded
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1revenue: Floatcurrency: Stringreason: Stringoffer_type: String
Event name: PURCHASE
Default event alias: apphud_subscription_started
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1revenue: Floatcurrency: String
Event name: PURCHASE
Default event alias: apphud_subscription_renewed
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1revenue: Floatcurrency: String
Default event name and alias: apphud_subscription_expired
Parameters:
product_id: Stringreason: String
Event name: PURCHASE
Default event alias: apphud_subscription_refunded
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1revenue: Floatcurrency: Stringreason: String
Event name: PURCHASE
Default event alias: apphud_promo_started
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1offer_id: Stringrevenue: Floatcurrency: Stringoffer_type: Stringunit: Stringunits_count: Integer
Event name: PURCHASE
Default event alias: apphud_promo_renewed
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1offer_id: Stringrevenue: Floatcurrency: Stringoffer_type: Stringunit: Stringunits_count: Integer
Event name: PURCHASE
Default event alias: apphud_promo_converted
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1offer_id: Stringrevenue: Floatcurrency: Stringoffer_type: String
Default event name and alias: apphud_promo_expired
Parameters:
product_id: Stringoffer_id: Stringreason: Stringoffer_type: String
Event name: PURCHASE
Default event name: apphud_promo_refunded
Parameters:
content_items[0].$sku: Stringcontent_items[0].$price: Floatcontent_items[0].$quantity= 1offer_id: Stringrevenue: Floatcurrency: Stringreason: Stringoffer_type: String
Set up Subscription Status URL to receive autorenew_disabled and autorenew_enabled events in real-time. More information can be found here.
Please make sure Branch SDK is properly integrated in your app and Branch integration is configured in Apphud.
Open Xcode, remove your app from test device, reset Advertising Identifier and Run the app.
We recommend calling setIntegrationsTestMode() in order not to send test data to production environment.
Make a test purchase.
You can read more about testing purchases here.
You will see attribution data in user's page:
Open "Liveview" tab in Branch and you will see Apphud events there.
Don't forget to switch Branch to TEST mode if you use setIntegrationsTestMode().
