API Reference

surveySubmit

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.