Survey Submitted Webhook

The “Survey Submitted” webhook is triggered whenever a survey is completed. Typically this will be when a participant completes the survey in the MyDataHelps app/website, but it will also be triggered when a coordinator completes the survey on the participant’s behalf.

Event Data

The following data will be included as a JSON payload in the POST request when the webhook is triggered.

eventType string

Identifies the event type. In this case, SurveySubmitted.

projectID

The project identifier.

participantID guid

Internal participant ID.

participantIdentifier string

Project-specific participant identifier.

surveyID guid

Identifier for the survey the event is associated with.

surveyResultID guid

Identifier for the survey result the event is associated with.

surveyVersion integer

Which version of the survey was responded to.

taskID guid

Identifier for the survey task the event is associated with.

surveyName string

The name of the survey the event is associated with.

Sample Webhook Data
{
  "eventType": "SurveySubmitted",
  "projectID": "3a713a06-295d-4803-9602-776f09a1483b",
  "participantID": "419d567e-76e6-4b53-8b3c-567d7260a85d",
  "participantIdentifier": "PT-123",
  "linkIdentifier": "0971fbcd-ec92-414c-bd49-41a3c8b6547b",
  "surveyID": "083b44c8-4273-4ad5-9132-3dce126d5e62",
  "surveyResultID": "230b27b1-df0d-441d-8485-a929cdf4895a",
  "surveyVersion": 8,
  "taskID": "5a613cf2-97ee-4fca-b2f7-ea79c5d6d35e",
  "surveyName": "Sleep Time"
}
{ "eventType": "SurveySubmitted", "projectID": "3a713a06-295d-4803-9602-776f09a1483b", "participantID": "419d567e-76e6-4b53-8b3c-567d7260a85d", "participantIdentifier": "PT-123", "linkIdentifier": "0971fbcd-ec92-414c-bd49-41a3c8b6547b", "surveyID": "083b44c8-4273-4ad5-9132-3dce126d5e62", "surveyResultID": "230b27b1-df0d-441d-8485-a929cdf4895a", "surveyVersion": 8, "taskID": "5a613cf2-97ee-4fca-b2f7-ea79c5d6d35e", "surveyName": "Sleep Time" }