Exam Started Webhook

This event is triggered when a user's exam attempt has been Started. Please note, for attempts relating to an non-Exam attempt, you should use the Attempt Started webhook instead.

To subscribe to this webhook, please set up a URL endpoint capable of receiving POST requests.

Request Details

The request will POST a JSON payload that conforms to the following Typescript interface:

export interface ExamStartedWebhookBody {
  id: string;
  meta: { timestamp: string; eventName: 'exam.started' };
  portal: { id: string };
  user: {
    id: string;
    name: string;
    email: string;
    customAttributes: Record<string, unknown>;
  };
  test: { id: string; title: string };
  exam: { 
    id: string;
    name: string;
    attr?: Record<string, unknown>;
    resitCount: number;
    sourceTests: string[];
    userGroup: {id: string; name: string}
  }
  timeStarted: string;
  attempt: {
    id: string;
    isExam: true;
    state: {
      responseQuestionMap: string[][];
      isRevoked: boolean;
      isStarted: boolean;
      timeStarted: string;
    };
    totalQuestions: number;
    tags: {
      nonFacetTags: string[];
      skill: string[];
      difficulty: string[];
      subtopic: string[];
      topic: string[];
      subject: string[];
      module: string[];
      exam: string[];
    };
    timeStarted: string;
  };
}

This should contain all of the information you need for most common use cases, such as emailing a confirmation to the user, or adding the attempt information to another system. You can also use this in conjunction with our APIs to fetch more data if needed.