Skip to main content
Version: v1.0.0


The CheckboxResponse interface is used to define the properties of a checkbox response. CheckboxResponses render as a checkbox input with user specified options.

"id": "q7",
"prompt": "Checkbox example (not required)",
"required": false,
"location": "aboveStimulus",
"type": "checkbox",
"options": [
"label": "Option 1",
"value": "opt-1"
"label": "Option 2",
"value": "opt-2"
"label": "Option 3",
"value": "opt-3"



PropertyTypeDescriptionInherited from
hidden?booleanControls whether the response is hidden.BaseResponse.hidden
idstringThe id of the response. This is used to identify the response in the data
location?"sidebar" | "aboveStimulus" | "belowStimulus"Controls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulusBaseResponse.location
optionsStringOption[]The options that are displayed as checkboxes, provided as an array of objects, with label and value fields.-
paramCapture?stringUse to capture querystring parameters in answers such as participant_name. See the examples for how this is used, but prefer uiConfig.urlParticipantIdParam if you are capturing a participant ID.BaseResponse.paramCapture
promptstringThe prompt that is displayed to the participant. You can use markdown here to render images, links, etc.BaseResponse.prompt
requiredbooleanControls whether the response is required to be answered.BaseResponse.required
requiredLabel?stringYou can provide a required label, which makes it so a participant has to answer with a response that matches label.BaseResponse.requiredLabel
requiredValue?unknownYou can provide a required value, which makes it so a participant has to answer with that value.BaseResponse.requiredValue
secondaryText?stringThe secondary text that is displayed to the participant under the prompt. This does not accept markdown.BaseResponse.secondaryText