Initialization Option Items API

events

Enables the use of Events API in the current assessment.

You would want to use this option so that you can monitor and interact with assessments in real-time, for example. This allows proctors to remotely control an active assessment with actions such as: pausing an assessment, saving an assessment, extending assessment timers and several other actions.

Examples

// Enable the use of Events API
var initializationOptions = {
    "config": {
        "configuration": {
            "events": true
        }
    }
};

Values

Request object key config.configuration.events

Default: false

Type boolean

Caveats

Important Events API must be enabled on your consumer for this option to take effect.

Related articles

Was this article helpful?