Skip to content

The optional timer object adds a countdown or count-up timer to the form. When time expires, a custom message and button are shown.

Not every form has a timer. It only appears when added as a form field in the builder.

Schema

FieldTypeDescription
isEnabledbooleanEnable the timer
secondsnumberTotal duration in seconds
hoursTextstringLabel for the hours display
minutesTextstringLabel for the minutes display
secondsTextstringLabel for the seconds display
isCountUpbooleanCount up instead of down
timeExpiredMessagestringMessage shown when time runs out
timeExpiredButtonstringButton label when time runs out
timeExpiredTitlestringTitle shown when time runs out
timeExpiredMessageWithInvalidFormstringMessage when time runs out but required fields are incomplete
timeExpiredButtonWithInvalidFormstringButton label for the incomplete-form state
"timer": {
  "isEnabled": true,
  "seconds": 5445,
  "hoursText": "Hours",
  "minutesText": "Minutes",
  "secondsText": "Seconds",
  "isCountUp": false,
  "timeExpiredMessage": "Please submit your answers",
  "timeExpiredButton": "Submit",
  "timeExpiredTitle": "Time's up!",
  "timeExpiredMessageWithInvalidForm": "You need to answer all the required questions to submit your response.",
  "timeExpiredButtonWithInvalidForm": "Start over"
}