JavaScript Events

AutoProctor's functionality is driven by JavaScript events. Use these events to manage the candidate flow in your integration. There are two types:

• Regular events: The most important events are emitted directly to the Window target
• Custom events: The less important events are emitted as a Custom Event. The specific event (for example, ML Model is loaded) is added to the detail property of the event.

Regular events

To show a quiz's <div> once monitoring has begun:

window.addEventListener('apMonitoringStarted', () => {
  div.style.visibility = 'visible'
})

AutoProctor emits the following events:

Custom Events

An AutoProctor custom event can be one of: apSuccessEvent, apErrorEvent or apEvidenceEvent. For example, to enable a button when ML models are loaded:

window.addEventListener('apSuccessEvent', (e) => {
  const { successCode } = e.detail
  if (successCode === 2003) {
    btn.disabled = false
  }
})

apSuccessEvent - Success Events

apErrorEvent - Error Events

apEvidenceEvent - Evidence Events

The apEvidenceEvent provides detailed information about potential violations through its detail property. Available fields:

• evidenceCode: The numeric code identifying the type of violation (5001-5010)
• evidenceDetails: Additional context about the violation
• evidenceURL: URL to the evidence (usually a screenshot or audio clip)
• violationCount: Number of times this specific violation has occurred

The following example auto-submits a test after the candidate exceeds a maximum number of tab switches:

const MAX_TAB_SWITCHES_BEFORE_SUBMIT = 2;

window.addEventListener("apEvidenceEvent", (e) => {
    const { evidenceCode, evidenceURL, violationCount } = e.detail;

    // 5005 is the code for tab switching violation
    // Auto-submit the test after exceeding tab switch limit
    if (evidenceCode === 5005) {
      if (violationCount > MAX_TAB_SWITCHES_BEFORE_SUBMIT) {
        document.getElementById("testEndBtn").click(); // or your equivalent submission logic
      } else {
        showAlert(`
          <p>
            Our system detected that you switched tabs.
            Please refrain from switching tabs, or else your test will be submitted automatically.
          </p>
        `);
      }
    }
});

Handle other violations by checking their respective evidenceCode. For example, to detect when multiple people are in the frame:

window.addEventListener("apEvidenceEvent", (e) => {
    const { evidenceCode } = e.detail;

    if (evidenceCode === 5002) {
        alert("Warning: Multiple people detected in camera frame");
    }
});