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

# surveySubmit

`POST surveySubmit` (webhook)

The webhook is triggered when a candidate submits a non-anonymous survey. It will not fire for anonymous survey submissions.

Depending on the type of survey that was submitted, survey responses may be included in the webhook payload:
  - **Questionnaires**, **Candidate Data Consent** - Survey responses will be included in the payload.
  - **Candidate Experience** - If the submission is not anonymous, survey responses will be included in the payload. If the submission is anonymous, the webhook will not trigger.
  - **Diversity Surveys**, **EEOC Surveys** - Survey responses will never be included in the payload.

If survey responses are included in the payload, the `submittedValues` field will contain the submitted answers in an object where each key is the path of the field and the value is the value submitted for that field.

## Payload

- object
  - `action` 'surveySubmit', required
  - `data` object, required
    - `surveySubmission` OverlaySurveySubmission
      - `id` string, uuid, required
      - `surveyFormDefinitionId` string, uuid
      - `submittedAt` string, date-time, required
      - `candidateId` string, uuid, required — The id of the candidate who submitted the survey
      - `applicationId` string, uuid — The id of the application that the survey submission is associated with
      - `surveyType` 'CandidateDataConsent' | 'CandidateExperience' | 'Diversity' | 'EEOC' | 'Questionnaire', required
      - `formDefinition` OverlayFormDefinition
        - `sections` object[]
          - `title` string
          - `descriptionHtml` string
          - `descriptionPlain` string
          - `fields` object[], required
            - `isRequired` boolean, required
            - `descriptionHtml` string
            - `descriptionPlain` string
            - `field` object, required
              - …
      - `submittedValues` object

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