> For the complete documentation index, see [llms.txt](https://academy.synap.ac/doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.synap.ac/doc/integrations/webhooks/exam-started-webhook.md).

# 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:

```typescript
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.&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://academy.synap.ac/doc/integrations/webhooks/exam-started-webhook.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.