This guide covers the xAPI / LRS integration in BricksMembers. With this integration, you can send learning events (progress completed, certificates, quiz results, submissions) to an external Learning Record Store for enterprise reporting and analytics.
What Is xAPI / LRS?
xAPI (Experience API) is a standard for tracking learning experiences. A Learning Record Store (LRS) receives and stores these events. Popular LRS providers include Learning Locker, SCORM Cloud, Grassblade, and Veracity Learning. BricksMembers sends xAPI 1.0.3 statements when configured events occur.
Prerequisites
- At least one event module enabled (Progress Tracking, Certificates, Quiz, or Submissions)
- An LRS account with endpoint URL, key (username), and secret (password)
- HTTPS endpoint (required for security)
Step 1: Enable an Event Module
xAPI requires at least one event-emitting module. Enable Progress Tracking, Certificates, Quiz, or Submissions in BricksMembers → Settings → Modules.
Step 2: Enable xAPI / LRS
Go to BricksMembers → Settings → Integrations. In the integrations list, the xAPI card shows a green check when event modules are active. Check xAPI / LRS and click Save Settings.
When enabled, the xAPI / Learning Record Store card appears below with configuration fields.
Step 3: Configure Endpoint and Credentials
- Enter your Endpoint URL (e.g.
https://lrs.example.com/xapi/) - Enter your Key and Secret from your LRS
- Select which events to send (progress completed, certificate issued, quiz passed/failed, submission reviewed)
- Click Save Settings
The xAPI queue table is created when enabled, and the integration begins listening for events once configured.
Step 4: Verify
Check your LRS dashboard to confirm statements are arriving.
Event Types
You can choose which events to send:
- Progress completed — When a user completes a post or course
- Certificate issued — When a certificate is awarded
- Quiz passed — When a user passes a quiz
- Quiz failed — When a user fails a quiz
- Submission reviewed — When an assignment submission is reviewed
How It Works
Events are queued and processed in the background (about every 5 minutes). Learners experience no delay—events are sent asynchronously. If a send fails (e.g. LRS temporarily unavailable), the event stays in the queue and is retried on the next run. Check your LRS dashboard to verify statements are arriving.
Troubleshooting
Events not appearing in LRS — Verify endpoint URL (HTTPS), key, and secret. Enable WP_DEBUG_LOG and look for “xAPI LRS statement failed” in wp-content/debug.log.
Auth errors — Ensure key and secret match your LRS credentials exactly (no extra spaces).
Endpoint unreachable — Check firewall rules and SSL certificate. Some hosts block outbound requests; contact your host if needed.
