ABXRLib SDK for WebXR

The name "ABXR" stands for "Analytics Backbone for XR"—a flexible, open-source foundation for capturing and transmitting spatial, interaction, and performance data in XR. When combined with ArborXR Insights, ABXR transforms from a lightweight instrumentation layer into a full-scale enterprise analytics solution—unlocking powerful dashboards, LMS/BI integrations, and AI-enhanced insights.

Table of Contents

1. Introduction
2. Installation
3. Configuration
4. Quick Start
5. Full Documentation
6. Support

---

Introduction

Overview

The ABXRLib SDK for WebXR is an open-source analytics and data collection library that provides developers with the tools to collect and send XR data to any service of their choice. This library enables scalable event tracking, telemetry, and session-based storage—essential for enterprise and education XR environments.

Quick Start: Most developers can integrate ABXRLib SDK and log their first event in under 15 minutes.

Why Use ABXRLib SDK?

• Open-Source & portable to any backend—no vendor lock-in
• Quick integration—track user interactions in minutes
• Secure & scalable—ready for enterprise use cases
• Pluggable with ArborXR Insights—seamless access to LMS/BI integrations, session replays, AI diagnostics, and more

Core Features

The ABXRLib SDK provides:

• Event Tracking: Monitor user behaviors, interactions, and system events.
• Spatial & Hardware Telemetry: Capture headset/controller movement and hardware metrics.
• Object & System Info: Track XR objects and environmental state.
• Storage & Session Management: Support resumable training and long-form experiences.
• Logs: Developer and system-level logs available across sessions.

Backend Services

The ABXRLib SDK is designed to work with any backend service that implements the ABXR protocol. Currently supported services include:

ArborXR Insights

When paired with ArborXR Insights, ABXR becomes a full-service platform offering:

• Seamless data pipeline from headset to dashboard
• End-to-end session tracking, analysis, and replay
• AI-driven insights for content quality, learner performance, and device usage
• One-click LMS and BI integrations for scalable deployments

Custom Implementations

Developers can implement their own backend services by following the ABXR protocol specification. This allows for complete control over data storage, processing, and visualization.

---

Installation

NPM Package Installation

npm install abxrlib-for-webxr

CDN Installation

<script src="https://cdn.jsdelivr.net/npm/abxrlib-for-webxr@latest/Abxr.js"></script>

Manual Installation

1. Download the latest release from the GitHub repository.
2. Include the Abxr.js file in your project.
3. Initialize the library in your application.

---

Configuration

Using with ArborXR Insights

To use the ABXRLib SDK with ArborXR Insights:

Get Your Credentials

The SDK authenticates using a JWT App Token and Org Token.

• App Token: Available in the ArborXR portal under Content Library → Managed app → Insights Hub.
• Org Token: Not currently exposed in the portal UI. Contact ArborXR support to request a customer-specific Org Token for single-customer production builds.

Configure Web Application

The SDK accepts an AbxrInitOptions object. Three deployment paths are supported, differing in how the Org Token is supplied. The App Token identifies the application; the Org Token directs which organization receives the data.

Path A: Developer mode

For local development, internal testing, or apps where the developer is also the customer organization, pass the App Token as both values. All data routes to the developer's own organization.

import { Abxr_init, Abxr } from 'abxrlib-for-webxr';

Abxr_init({ appToken: 'your-app-token', orgToken: 'your-app-token' });

Abxr.Event('user_action', { action: 'button_click' });
Abxr.LogDebug('Debug message');

Path B: LMS integration

For enterprise rollouts through a Learning Management System, the customer configures your WebXR link inside their LMS activity. When a learner launches the activity, the LMS generates a dynamic Org Token scoped to that session and supplies it to the SDK automatically. Data routes to the customer's organization.

Initialize with only the App Token. The LMS handles the Org Token.

import { Abxr_init, Abxr } from 'abxrlib-for-webxr';

Abxr_init({ appToken: 'your-app-token' });

Path C: Per-customer embedded build

For single-customer production deployments not launched through an LMS, embed the customer's Org Token in the build. Request the Org Token from ArborXR support, as the portal UI does not currently expose it. Ship one build per customer organization.

import { Abxr_init, Abxr } from 'abxrlib-for-webxr';

Abxr_init({
    appToken: 'your-app-token',
    orgToken: 'customer-org-token-from-support'
});

Additional Init Options

The AbxrInitOptions object accepts the following optional fields for advanced use cases:

• appConfig (string): Custom app configuration JSON string.
• dialogOptions (AbxrAuthMechanismDialogOptions): Styling and behavior overrides for the built-in auth mechanism dialog.
• authMechanismCallback (AbxrAuthMechanismCallback): Replace the built-in auth dialog with a custom handler. Invoked when the backend requests user input (for example, a PIN or email prompt).

Refer to the full documentation for details on each option.

Using with Other Backend Services

For information on implementing your own backend service or using other compatible services, please refer to the ABXR protocol specification.

---

Quick Start

Essential Event Tracking (Required)

Assessment events are required to activate grading dashboards and LMS integration. Send these events to track training completion, scores, and pass/fail status.

// When training starts
Abxr.EventAssessmentStart('safety_training');

// When training completes
Abxr.EventAssessmentComplete('safety_training', 92, Abxr.EventStatus.Pass);
// or
Abxr.EventAssessmentComplete('safety_training', 25, Abxr.EventStatus.Fail);

Assessment Complete Parameters:

• Score (second parameter) takes a 0-100 value
• EventStatus (third parameter). The EventStatus accepts Pass, Fail, Complete, Incomplete, Browsed, NotAttempted values

Tracking Objectives (Recommended)

For more detailed tracking, you can also track specific objectives within your training:

// To mark a specific objective start
Abxr.EventObjectiveStart('open_valve');

// When the objective is complete
Abxr.EventObjectiveComplete('open_valve', 100, Abxr.EventStatus.Complete);

---

Full Documentation

For comprehensive documentation covering all features, advanced topics, and detailed examples, visit:

• ArborXR Insights Documentation - Main documentation hub
• Complete SDK Documentation - Full API reference and feature documentation

The full documentation includes:

• Complete event tracking API (Events, Analytics Event Wrappers, Timed Events)
• Advanced features (Module Targets, Authentication, Session Management)
• Storage, Telemetry, Logging, and AI Integration
• Mixpanel and Cognitive3D compatibility guides
• XR Dialog Customization
• Troubleshooting and best practices
• Platform-specific examples and code samples

---

Support

Resources

• Docs: https://help.arborxr.com/
• GitHub: https://github.com/ArborXR/abxrlib-for-webxr

FAQ

How do I retrieve my credentials?

The App Token is available in the ArborXR portal under Content Library → Managed app → Insights Hub. The Org Token is not currently exposed in the portal UI; contact ArborXR support to request a customer-specific Org Token. For local development, the App Token may be used as the Org Token, in which case data routes to your own organization.

For more troubleshooting help and detailed FAQs, see the full documentation.