Attempt Submitted Webhook

This event is triggered when a user's attempt on any test has been Submitted, regardless of whether or not it has been marked.

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

• For attempts which are manually marked, this will be sent before the Attempt 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 be sent for any attempt, including Collections, Spaced Learning, Assignments and Exams. We have a separate webhook just for Exam attempts which may be better depending on your use case.

Request Details

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

interface AttemptSubmittedWebhookBody {
  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: false;
    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 };
  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.