Exam Results Released Webhook

This event is triggered when a user's Exam results have been released.

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:

interface ExamResultsReleasedWebhookBody {
  user: {
    id: string;
    name: string;
    email: string;
    subPortalId?: string;
    customAttributes: {
      [key: string]: string | number | boolean | null;
    };
  };

  portal: {
    id: string;
  };

  meta: {
    timestamp: string;
    eventName: string;
  };

  attempt: {
    score: number;
    scoreFrac: number;
    totalAnsweredCorrectly: number;

    grade: {
      label: string;
      isPass: boolean;
      minScore: number;
    };

    gradeCriteria: {
      grades: {
        label: string;
        isPass: boolean;
        minScore: number;
      }[];
    };

    id: string;
    isExam: boolean;

    state: {
      responseQuestionMap: string[][];
      isRevoked: boolean;
      isStarted: boolean;

      instructions?: {
        isUnlocked: boolean;
        didProgress: boolean;
        timeStarted: string;
        timeCompleted: string;
        timeSpentInMs: number;
      };

      timeStarted: string;
      timeCompleted: string;
      timeSpentInMs: number;

      results: {
        markingStatus: string;
        pendingMarks: number;
        status: string;
      };

      deferred: {
        locked: boolean;
      };
    };

    marks: {
      maxPoints: number;
      credits: number;
      penalties: number;
      points: number;
    };

    totalQuestions: number;

    tags: {
      nonFacetTags: string[];
      context: string[];
      skill: string[];
      difficulty: string[];
      subtopic: string[];
      topic: string[];
      subject: string[];
      module: string[];
      exam: string[];
    };

    totalAnswered: number;
    timeStarted: string;
    timeCompleted: string;
    timeSpentInMs: number;

    status: string;
    examStatus: string;
    proctorStatus: string | null;

    assignedModeratingMarkers: {
      id: string;
    }[];

    marker: {
      id: string;
    };

    audit: {
      finalisedBy: string;
      finalisedAt: string;
      releasedBy: string;
      releasedAt: string;
    };

    resitCount: number;
  };

  test: {
    id: string;
    title: string;
  };

  id: string;
  timeStarted: string;
  timeCompleted: string;
  timeSpentInMs: number;

  exam: {
    id: string;
    name: string;

    attr: {
      "exam-weight": number;
      "exam-group-id": string;
      "publish-exam-grade": boolean;
      "plagiarism-checker-enabled": boolean;
      "scoring-model": string;
      qualification_name: string;
      cohort_number: string;
    };

    resitCount: number;
    sourceTests: string[];

    userGroup: {
      id: string;
      name: 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.