Exam Submitted Webhook

This event is triggered when a user's Exam attempt has been Submitted by a user.

• For exams which are automatically marked (e.g. pure MCQ exams), this will be sent at the same time as the Exam Completed webhook.

• For exams which are manually marked, this will be sent before the Exam Completed webhook. Submitted means that the user has Submitted the exam. Completed means that the exam, along with any associated marking, has been completed.

• This webhook will only be sent for an Exam attempt. To respond to any attempt on the platform, regardless of whether it is part of an Exam or not, you should use the Attempt Completed and/or Attempt Submitted webhooks

• If you are looking to use mark/score information, you should generally use the Exam Completed webhook instead, as this will be guaranteed to include marking information even if an exam required manual marking. The Submitted webhooks will only contain marking information if the exam could be automatically marked.

Request Details

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

interface ExamSubmittedWebhookBody {
  user: {
    id: string;
    name: string;
    email: string;
    customAttributes: Record<string, unknown>;
  };
  portal: { id: string };
  meta: { timestamp: string };
  attempt: {
    score: number;
    scoreFrac: number;
    totalAnsweredCorrectly: number;
    id: string;
    isExam: true;
    state: {
      responseQuestionMap: string[][];
      isRevoked: boolean;
      isStarted: boolean;
      sections: {
        items: [
          {
            sectionId: string;
            responseIds: string[];
            isOpen: boolean;
            isUnlocked: boolean;
            isCompleted: boolean;
            totalQuestionsCompleted: number;
            totalQuestionsSkipped: number;
            marks: Marks;
            timeStarted: string;
            timeCompleted: string;
            timeSpentInMs: number;
            score: number;
            scoreFrac: number;
            totalCorrect: number;
          }
        ];
      };
      timeStarted: string;
      timeCompleted: string;
      timeSpentInMs: number;
      results: { markingStatus: string; pendingMarks: number; status: string };
    };
    marks: Marks;
    totalQuestions: number;
    tags: {
      nonFacetTags: string[];
      skill: string[];
      difficulty: string[];
      subtopic: string[];
      topic: string[];
      subject: string[];
      module: string[];
      exam: string[];
    };
    totalAnswered: number;
    timeStarted: string;
    timeCompleted: string;
    timeSpentInMs: number;
  };
  test: { id: string; title: string };
  exam: {
    id: string;
    name: string;
    resitCount: number;
    sourceTests: string[];
    sectionGrades: {
      id: string;
      marks: Marks;
    }[];
    userGroup: {
      id?: string;
      name?: string;
    }
  };
  id: string;
  timeStarted: string;
  timeCompleted: string;
  timeSpentInMs: number;
}

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.