Skip to content

⚙️ Configuration

This page documents the configuration object used to initialize the Eye By Proctorme widget.

The configuration defines: - Which assessment is being proctored - Who the candidate is - How long the exam lasts - Which proctoring features are enabled

All fields listed here are derived directly from the widget API.

Configuration Object Overview

The widget is initialized using a single config object passed to:

widget.init(config);

Example:

const config = {
  apiKey: "YOUR_API_KEY", // (1)
  assessmentId: "assessment123",
  assessmentTitle: "Frontend Development Assessment",
  candidateId: "candidate456",
  candidateEmail: "test@example.com",
  candidateFirstName: "John",
  candidateLastName: "Doe",
  candidateImageUrl: "https://example.com/avatar.jpg",
  institutionName: "Tech Academy International",
  examDuration: 1800,
  features: {
    aiProctoring: true,
    facialRecognition: true,
  },
};
  1. 🔑 API Key Used to authenticate requests. Generate it from Settings → API & Integrations in the Eye Dashboard. 👉 Docs

apiKey (Required)

Your organisation’s Eye API key.

apiKey: "YOUR_API_KEY"

How to get your API key

Generate and copy your API key from the Eye admin dashboard:

Settings → API & Integrations
👉 API Key documentation

assessmentId (Required)

A unique identifier for the assessment being proctored.

assessmentId: "assessment123"
  • Must match an assessment created in the Eye dashboard
  • Used to associate flags and events with the correct exam

assessmentTitle (Required)

The human‑readable title of the assessment.

assessmentTitle: "Frontend Development Assessment"

This value is used for: - Logging - Reporting - Candidate review records

candidateId (Required)

A unique identifier for the candidate.

candidateId: "candidate456"

This ID links all monitoring events and flags to the candidate.

candidateEmail (Required)

The candidate’s email address.

candidateEmail: "test@example.com"

Used for: - Identification - Reporting - Administrative review

candidateFirstName (Required)

The candidate’s first name.

candidateFirstName: "John"

candidateLastName (Required)

The candidate’s last name.

candidateLastName: "Doe"

institutionName (Required)

The name of the institution conducting the assessment.

institutionName: "Tech Academy International"

Appears in: - Logs - Reports - Admin dashboard views

examDuration (Required)

Duration of the exam in seconds.

examDuration: 1800

Example durations

  • 30 minutes → 1800
  • 1 hour → 3600
  • 2 hours → 7200

candidateImageUrl (Optional)

URL to a reference image of the candidate.

candidateImageUrl: "https://example.com/avatar.jpg"

Used for: - Facial recognition comparison - Identity verification

Optional

If omitted, facial recognition can still run but without a reference image.

features (Optional)

Controls which proctoring features are enabled.

features: {
  aiProctoring: true,
  facialRecognition: true,
}

Available Feature Flags

Feature Type Description
aiProctoring boolean Enables AI‑based monitoring (face, sound, tab focus)
facialRecognition boolean Enables facial recognition snapshots

Default behavior

If features is omitted, all supported proctoring features may be enabled by default.

Minimal Required Configuration

const config = {
  apiKey: "YOUR_API_KEY", // (1)
  assessmentId: "assessment123",
  assessmentTitle: "Assessment Title",
  candidateId: "candidate456",
  candidateEmail: "candidate@email.com",
  candidateFirstName: "First",
  candidateLastName: "Last",
  institutionName: "Institution Name",
  examDuration: 1800,
};
  1. 🔑 API Key Used to authenticate requests. Generate it from Settings → API & Integrations in the Eye Dashboard. 👉 Docs

Validation Notes

Initialization will fail if:

  • Required fields are missing
  • The API key is invalid
  • The domain is not registered for the API key

← Quick Start Guide → | Next: API Methods →