Summary
The xAPI integration lets KnowledgeCity forward learning activity to an external Learning Record Store (LRS) as it happens. Using the outbound xAPI handler, KnowledgeCity builds and sends xAPI statements for key learning events so your reporting system receives a live record of learner progress. This article explains how to enable xAPI, point it at your LRS, secure the connection, and choose which events are sent.
Introduction
xAPI (also known as Tin Can) is a standard for describing learning experiences as statements and delivering them to a Learning Record Store. In KnowledgeCity, the outbound xAPI handler watches for learning events, translates each one into an xAPI statement, and posts it to the LRS you configure. This keeps an external analytics or compliance system in sync with what learners actually do inside the platform.
This configuration is managed by Super Admins and administrators who are responsible for connecting KnowledgeCity to outside reporting systems. It is useful whenever your organization consolidates learning data from multiple sources into a single LRS, or needs a durable, standards-based record of learner activity outside KnowledgeCity.
Key Concepts
- xAPI statement: a standardized record of a single learning event, describing the learner (actor), the action (verb), and the item acted on (object), which KnowledgeCity sends to your LRS.
- Learning Record Store (LRS): the external system that receives and stores the statements KnowledgeCity sends, so you can report on activity there.
- LRS host: the endpoint address of your LRS where KnowledgeCity posts statements.
- Bearer authentication: an option that authenticates each request to the LRS with a bearer token supplied by your LRS provider.
- Basic authentication: an option that authenticates each request using a username and password pair issued by your LRS.
- Custom headers: additional request headers you can add so KnowledgeCity includes any extra values your LRS requires on every call.
- Event mapping: the selection that controls which learning events are turned into statements, covering Registered, Attempted, Completed, Passed, Progress, and Initialized.
Steps to Follow
Opening the Integrations page
Sign in as a Super Admin, open the Settings menu in the top panel of the interface, and select Integrations. This opens the Integrations detail page, where connections to external systems are grouped into sections.
Enabling xAPI
Locate the xAPI configuration and turn on the option to Enable it. Enabling xAPI activates the outbound handler so that, from this point forward, learning events are eligible to be sent to your LRS.
Setting the LRS host
In the LRS host field, enter the endpoint address of your Learning Record Store. KnowledgeCity posts each xAPI statement to this address, so confirm the value with your LRS provider before you rely on the connection.
Choosing an authentication method
Select how KnowledgeCity should authenticate to your LRS:
- Choose Bearer and provide the bearer token supplied by your LRS.
- Choose Basic and provide the username and password issued by your LRS.
Use the method your LRS provider specifies, and treat the token, username, and password as secrets that should not be shared publicly.
Adding custom headers
If your LRS requires extra values on each request, add them as custom headers. For each header, provide its name and value. KnowledgeCity includes these headers on every statement it sends, alongside the authentication you configured.
Mapping which events are sent
Choose which learning events KnowledgeCity converts into statements. The handler can send statements for the following events:
- Registered: the learner is registered for a learning item.
- Initialized: the learner starts a learning item.
- Attempted: the learner makes an attempt at a learning item.
- Progress: the learner advances through a learning item.
- Completed: the learner finishes a learning item.
- Passed: the learner meets the passing criteria for a learning item.
Select only the events your reporting needs, so the LRS receives the statements that matter and is not filled with activity you do not track.
Saving and verifying
Save your configuration. After saving, generate the relevant learning activity and confirm the corresponding statements arrive in your LRS. If statements do not appear, recheck the LRS host, the authentication values, and any required custom headers.
Conclusion
Configuring the xAPI integration connects KnowledgeCity directly to your Learning Record Store, so registration, initialization, attempts, progress, completion, and passing events flow out as standardized statements as learners work. By enabling xAPI, setting the LRS host, securing the connection with Bearer or Basic authentication and any custom headers, and mapping the events you care about, you give your external reporting system a reliable, real-time view of learning activity.