Events API

This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans.

See our page on recommended deployment patterns for more information.

Events API provides a simple way to publish and subscribe events (compliant with Experience API) via Learnosity Products or Public Methods to the Learnosity Event Bus.

Events API Home

You would want to use this to create completely new events which do not exist in the Learnosity system.

Enabling Events API

Note Events API is a premium feature and must be enabled on your account in order to work. If you initialize Events API but it is not enabled on your account, you will see the following warning in the JavaScript console:

You specified `events: true` in your initialization options, but Events API is not enabled for your consumer. Specify `events: false`, or contact Learnosity support to enable Events API.

Contact Learnosity support to discuss enabling Events API.


Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.