---
title: "takeHomeAssignmentCompleted"
method: POST
path: "takeHomeAssignmentCompleted"
tags: ["Webhook Payloads"]
---

# takeHomeAssignmentCompleted

`POST takeHomeAssignmentCompleted` (webhook)

> Beta: This webhook may not be available for all organizations.

The webhook is called when a take-home assignment is completed.

## Payload

- object
  - `action` 'takeHomeAssignmentCompleted', required
  - `data` object, required
    - `takeHomeAssignment` OverlayTakeHomeAssignment
      - `id` string, required — The unique identifier for the take-home assignment
      - `applicationId` string, required — The id of the associated application
      - `candidateId` string, required — The id of the associated candidate
      - `interviewStageId` string — The interview stage associated with the take-home assignment, if any. Null if none is associated.
      - `status` 'WaitingOnSubmission' | 'WaitingOnFeedback' | 'Complete' | 'Cancelled', required — The current lifecycle status of the take-home assignment
      - `createdAt` string, date-time, required — The timestamp when the take-home was created
      - `updatedAt` string, date-time, required — The timestamp when the take-home was last updated
      - `submission` object — The candidate submission, or null until the candidate submits
        - `id` string, required — The unique identifier for the take-home submission
        - `submittedAt` string, date-time, required — The timestamp when the candidate submitted
        - `notesHtml` string — The candidate's submission notes rendered as HTML, if provided
        - `notesPlain` string — The candidate's submission notes rendered as plain text, if provided
        - `fileHandles` OverlayFileHandle[], required — File handles for submitted files. Resolve each handle with file.info.
          - `id` string, required
          - `name` string, required
          - `handle` string, required — You can use the file handle to retrieve the file's URL by using the file.info endpoint.
      - `feedbackFormDefinitionId` string, required — The feedback form definition reviewers use for this take-home
      - `reviewers` object[], required — The assigned take-home reviewers
        - `userId` string, required — The id of the assigned reviewer
        - `interviewEventId` string, required — The interview event id used for interview briefings and feedback submission
        - `feedbackLink` string, required — The Ashby app link for submitting reviewer feedback
        - `hasSubmittedFeedback` boolean, required — Whether this reviewer has submitted take-home feedback
        - `feedbackSubmittedAt` string, date-time — The timestamp when feedback was submitted, if it has been submitted. Null if not yet submitted.

## Acknowledgement `200`

Return a 200 status to indicate that the data was received successfully

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)