Search specific term/phrase surrounded by double quotes. e.g. “deep linking”
Exclude records that contain a specific term prefixed with a minus. e.g. Android -Firebase
Guides
Submit a TicketBranch DashboardBranch Dashboard

Web SDK

Integrate Branch features like deep linking and attribution into your web app.

Suggest Edits

Overview

Unlock the industry's most powerful deep linking and attribution functionality using the Branch Web SDK.

Why use the Branch Web SDK?

The Branch Web SDK has a number of benefits, including:

  • Attribution capabilities that help determine whether a last touch event led to a conversion.
  • Comprehensive event data that you can view in the Branch Dashboard and utilize to help drive ad campaign optimization.
  • Access to Branch Journeys, a feature that helps move users from the web to your app. Journeys is included in our Engagement package.

SDK Stats

SDK Size: 50kb

Speed: Median 80ms to 250ms

GitHub

Branch Web SDK GitHub Repository

Sample Application

The following sample application allows you to test creating Branch Events, Links, QR Codes, and Journeys.

Use the Branch SDK Web Full Reference guide for definitions and code samples related to methods used in the sample application.

To use the demo:

  1. Visit the Branch Web SDK sample application live page.

  2. In the API Settings section, enter in your Branch Live Key, which you can find in the Account Settings page of your Branch Dashboard.

  3. Click the Update API Settings button.

  4. To test sending Branch Events, click the Create Custom Event button. If you would like to see the headers and payload associated with the event, you can do so using the Network tab of browser's developer tools.

  5. To confirm that a Branch Event was sent successfully, go to the Liveview page of the Branch Dashboard and filter by custom event. Please note that it may take a few minutes to see your events show up.

  6. Explore the rest of the sample application using the available buttons, and see what is sent in the request and what is returned in the response when you do so.

  7. Review the project on GitHub to see how the different Branch Web SDK methods are used in the sample application.

Basic Integration

For steps on how to integrate the Branch Web SDK and validate your integration, visit our Basic Integration guide.

Feature Implementation

To start integrating Branch Web SDK features, visit our Advanced Features guide.

Testing and Troubleshooting

To validate your Branch Web SDK integration, visit our Testing guide.

If you run into issues with your integration, check out our Troubleshooting guide.

Full Reference

To see the public methods made available by the Branch Web SDK, visit our Full Reference guide.

Updated 4 days ago

Recommended Next Steps