Branch Web SDK

Branch Metrics Deep Linking/Smart Banner Web SDK. Please see the SDK documentation for full details.

• Web Demo App
• Basic Integration
• Advanced Features
• Testing
• Troubleshooting
• Web Full Reference

Installation

Add the loader to your page and initialize with your Branch key from the Branch dashboard. Calls made before the SDK finishes loading are queued and replayed.

<script>
  (function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="https://cdn.branch.io/branch-latest.min.js";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setAPIUrl getAPIUrl setDMAParamsForEEA referringLink".split(" "), 0);

  branch.init('key_live_YOUR_KEY', function (err, data) {
    // data contains the session and any deep link data
  });
</script>

Or install from npm:

npm install branch-sdk

const branch = require('branch-sdk');

branch.init('key_live_YOUR_KEY', function (err, data) {});

See Basic Integration for the full setup.

Running locally

Requires Node 24 and pnpm (both provided by the nix dev shell).

pnpm run start:dev   # first run prompts for your Branch key, API endpoint and port (default 3000)
# Navigate to http://localhost:3000/dev.html

Bugs / Help / Support

Report bugs and feature requests in this repo's issues. For help with your integration or anything else that isn't a bug, submit a ticket or email [email protected]. To report a security issue, see SECURITY.md.