> ## Documentation Index
> Fetch the complete documentation index at: https://ai-recruiter.micro1.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Event types

> List of supported event types and their payload.

### `interview.started`

Occurs whenever an **interview is started**.

<Accordion title="Sample Request Body">
  ```json theme={null}
  {
    "event": "interview.started",
    "data": {
      "candidate_id": "123a4567-e89b-12d3-a456-426614174000",
      "candidate_name": "John Doe",
      "candidate_email_id": "john.doe@micro1.ai",
      "job_id": "123b4567-e89b-12d3-a456-426614174000",
      "job_name": "Backend Developer",
      "ats_job_id": "JOB123TEST",
      "ats_job_application_id": null,
      "interview_id": "123c4567-e89b-12d3-a456-426614174000",
      "interview_name": "Backend Developer Interview",
      "date_started": "2024-01-01 10:00:00"
    }
  }
  ```
</Accordion>

### `interview_report.created`

Occurs whenever an **interview report is successfully generated**.

<Accordion title="Sample Request Body">
  ```json theme={null}
  {
    "event": "interview_report.created",
    "data": {
      "report_id": "h0gqkAcaDJ",
      "interview_id": "123e4567-e89b-12d3-a456-426614174000",
      "session_id": "123e4567-e89b-12d3-a456-426614174000",
      "interview_name": "Full Stack Engineer Interview",
      "candidate_id": "123e4567-e89b-12d3-a456-426614174000",
      "job_applicant_id": "123e4567-e89b-12d3-a456-426614174000",
      "ats_job_application_id": "ABCD1234",
      "ats_job_id": "ABCD1234",
      "candidate_name": "John Doe",
      "candidate_email_id": "john.doe@micro1.ai",
      "report_date": "2024-01-01",
      "report_url": "https://micro1.ai/report/h0gqkAcaDJ.pdf",
      "interview_recording_url": "https://micro1.ai/interview/h0gqkAcaDJ.m3u8",
      "proctoring_score": 85,
      "ai_match_score": 85,
      "proctoring_violations": [
        {
          "type": "tab_switch",
          "value": "3",
          "description": "3 tab switches detected, indicating multitasking or external searches."
        }
      ],
      "interview_transcript": [
        {
          "timestamp": 100,
          "role": "interviewer",
          "content": "Can you tell me about yourself?"
        }
      ],
      "technical_skills_evaluation": [
        {
          "skill": "React.js",
          "ai_evaluation": {
            "feedback": "Candidate has demonstrated a solid understanding of optimizing FastAPI performance.",
            "rating": "Senior"
          },
          "timestamp": 100
        }
      ],
      "soft_skills_evaluation": [
        {
          "skill": "Overall",
          "ai_evaluation": {
            "feedback": "Candidate demonstrated clear and organized thoughts throughout the interview, effectively addressing each question with relevant examples and explanations",
            "rating": "B1",
            "sub_score": {
              "vocabulary": "Candidate demonstrated a good vocabulary.",
              "grammar": "Candidate demonstrated a good grammar.",
              "critical_thinking": "Candidate demonstrated a good critical thinking."
            }
          }
        }
      ],
      "coding_skills_evaluation": {
        "feedback": "The candidate has demonstrated a good understanding of the problem",
        "rating": "Senior"
      },
      "custom_exercise_evaluation": {
        "feedback": "The candidate displayed a strong grasp of the custom exercise requirements and solved the problem effectively.",
        "rating": "Senior"
      },
      "custom_question_evaluation": [
        {
          "question_text": "Are you willing to relocate?",
          "answer_text": "Yes, I am willing to relocate",
          "ai_evaluation": {
            "feedback": "Candidate is willing to relocate with a 20% chance",
            "rating": "Great Answer"
          }
        }
      ],
      "date_created": "2021-01-01 00:00:00",
      "date_modified": "2021-01-01 00:00:00",
      "status": "active"
    }
  }
  ```
</Accordion>

### `interview_recording.completed`

Occurs whenever the **interview recording is successfully processed and available**.

<Accordion title="Sample Request Body">
  ```json theme={null}
  {
    "event": "interview_recording.completed",
    "data": {
      "report_id": "ABCD1234",
      "candidate_id": "123e4567-e89b-12d3-a456-426614174000",
      "interview_recording_url": "https://url_to_interview_recording.m3u8",
      "interview_recording_player_url": "https://zara.micro1.ai/ai-interview-videos/ABCDXYZ"
    }
  }
  ```
</Accordion>

### `interview_webcam_recording.completed`

Occurs whenever the **interview webcam recording is successfully processed and available**.

<Accordion title="Sample Request Body">
  ```json theme={null}
  {
    "event": "interview_webcam_recording.completed",
    "data": {
      "report_id": "ABCD1234",
      "candidate_id": "123e4567-e89b-12d3-a456-426614174000",
      "interview_webcam_recording_url": "https://url_to_interview_webcam_recording.m3u8",
      "interview_webcam_recording_player_url": "https://zara.micro1.ai/ai-interview-videos/ABCDXYZ"
    }
  }
  ```
</Accordion>

### `proctoring_score.completed`

Occurs whenever the **proctoring score is successfully calculated**.

<Accordion title="Sample Request Body">
  ```json theme={null}
  {
    "event": "proctoring_score.completed",
    "data": {
      "report_id": "ABCD1234",
      "candidate_id": "123e4567-e89b-12d3-a456-426614174000",
      "proctoring_score": 85
    }
  }
  ```
</Accordion>

### `applicant.created`

Occurs whenever the **a new applicant is created**.

<Accordion title="Sample Request Body">
  ```json theme={null}
  {
    "event": "applicant.created",
    "data": {
      "resume_score": "99.99",
      "ats_job_application_id": "TEST123",
      "ats_job_id": "TESTJOBID456",
      "micro1_job_id": "123a4567-e89b-12d3-a456-426614174000",
      "email_id": "john.doe@test.com",
      "micro1_job_application_id": "123b4567-e89b-12d3-a456-426614174000",
      "candidate_id": "123c4567-e89b-12d3-a456-426614174000",
      "candidate_name": "John Doe",
      "job_name": "Test Engineer",
      "stage": "Test Stage",
      "date_created": "2099-12-31 23:55:00",
      "date_modified": "2100-01-01 00:00:00",
      "resume_url": "https://example.com/john-doe-resume.pdf"
    }
  }
  ```
</Accordion>

### `applicant.invited`

Occurs whenever the **an applicant is invited to an interview**.

<Accordion title="Sample Request Body">
  ```json theme={null}
  {
    "event": "applicant.invited",
    "data": {
      "resume_score": "99.99",
      "ats_job_application_id": "TEST123",
      "ats_job_id": "TESTJOBID456",
      "micro1_job_id": "123a4567-e89b-12d3-a456-426614174000",
      "email_id": "john.doe@test.com",
      "micro1_job_application_id": "123b4567-e89b-12d3-a456-426614174000",
      "candidate_id": "123c4567-e89b-12d3-a456-426614174000",
      "candidate_name": "John Doe",
      "job_name": "Test Engineer",
      "stage": "Test Stage",
      "date_created": "2099-12-31 23:55:00",
      "date_modified": "2100-01-01 00:00:00",
      "resume_url": "https://example.com/john-doe-resume.pdf"
    }
  }
  ```
</Accordion>

### `applicant.updated`

Occurs whenever the **an applicant is updated**.

<Accordion title="Sample Request Body">
  ```json theme={null}
  {
    "event": "applicant.updated",
    "data": {
      "resume_score": "99.99",
      "ats_job_application_id": "TEST123",
      "ats_job_id": "TESTJOBID456",
      "micro1_job_id": "123a4567-e89b-12d3-a456-426614174000",
      "email_id": "john.doe@test.com",
      "micro1_job_application_id": "123b4567-e89b-12d3-a456-426614174000",
      "candidate_id": "123c4567-e89b-12d3-a456-426614174000",
      "candidate_name": "John Doe",
      "job_name": "Test Engineer",
      "stage": "Test Stage",
      "date_created": "2099-12-31 23:55:00",
      "date_modified": "2100-01-01 00:00:00",
      "resume_url": "https://example.com/john-doe-resume.pdf"
    }
  }
  ```
</Accordion>

### `applicant.completed`

Occurs whenever the **applicant's resume is successfully processed and resume score is generated**.

<Accordion title="Sample Request Body">
  ```json theme={null}
  {
    "event": "applicant.completed",
    "data": {
      "resume_score": "99.99",
      "ats_job_application_id": "TEST123",
      "ats_job_id": "TESTJOBID456",
      "micro1_job_id": "123a4567-e89b-12d3-a456-426614174000",
      "email_id": "john.doe@test.com",
      "micro1_job_application_id": "123b4567-e89b-12d3-a456-426614174000",
      "candidate_id": "123c4567-e89b-12d3-a456-426614174000",
      "candidate_name": "John Doe",
      "job_name": "Test Engineer",
      "stage": "Test Stage",
      "date_created": "2099-12-31 23:55:00",
      "date_modified": "2100-01-01 00:00:00",
      "resume_url": "https://example.com/john-doe-resume.pdf"
    }
  }
  ```
</Accordion>