WebLayer SDK

This SDK is used to track user behaviour and send it to WebLayer so it can be used as context by coding agents through the WebLayer MCP.

Installation

npm install weblayer-sdk

Or via CDN:

<script src="https://unpkg.com/@face2face-io/weblayer-sdk@latest/dist/weblayer-sdk.min.js"></script>

Usage

Browser (script tag)

<script src="https://unpkg.com/@face2face-io/weblayer-sdk@latest/dist/weblayer-sdk.min.js"></script>
<script>
  WebLayerSDK.init('your-org-id', {
    debug: false,
    apiUrl: 'https://api.weblayer.ai'  // optional
  });
</script>

Browser (ES modules / bundler)

import WebLayerSDK from 'weblayer-sdk';

WebLayerSDK.init('your-org-id', {
  debug: false,
  apiUrl: 'https://api.weblayer.ai'  // optional
});

Configuration

WebLayerSDK.init(orgId, options)

• orgId (required): Your organization ID
• options (optional):
  • apiUrl (string): API endpoint URL (default: https://api.weblayer.ai)
  • debug (boolean): Enable debug logging (default: false)
  • weblayerEnabled (boolean): Enable/disable tracking (default: true)

Features

• Cookie-based visitor ID (works across subdomains)
• Session-based tracking
• Automatic event tracking:
  • Clicks
  • Form interactions
  • Scroll behavior
  • Navigation events
  • Network requests
  • Errors and console warnings
  • Media events
  • Touch events
  • Dead-click detection

Visitor ID

The SDK automatically creates and stores a visitor ID in a cookie with domain scope (e.g., .example.com), allowing the same visitor to be tracked across all subdomains (app.example.com, www.example.com, docs.example.com, etc.).

License

ISC