Lua Scripting Resources

Important Update to Custom Scripting

SurveyGizmo's CustomScript Action now supports the LUA programming language.

Legacy Custom Scripting Language Deprecation Plans

New accounts (created after October 29, 2018) will only have the option to use Lua in scripts.
As of October 29, 2018 Custom Scripting Actions will default to Lua as the scripting type in the Custom Scripting Action for accounts created before this date. You will be able to switch to the Legacy Custom Scripting; though we highly encourage using Lua.
In the long term, Legacy Custom Scripting Actions will be switched to read-only. Read-only scripts will continue to function; you will just be prevented from editing. The exact date on this is to be determined; we will send notifications well ahead of time.

Go to our Legacy Scripting Documentation.

While SurveyGizmo is one of the most flexible survey tools around, we get requests for customizations that are not available out of the box. This is where JavaScript and Custom Scripting can save the day. If you have scripting chops you can use the JavaScript action or the Custom Scripting action to achieve the survey of your dreams.

[article("bodfy")]

There are five categories of custom scripting functions available:

Survey Getter Functions - Survey getter functions allow you to fetch various values throughout the survey.

Survey Setter Functions - Survey setter functions allow you to set various values throughout the survey.

Logic, Piping, and Randomization Functions - These functions allow you to replicate and extend our built-in logic, piping/repeating, and randomization features.

Results Functions - Results functions allow you to fetch aggregate data to build custom quotas and customize other survey behavior.

Survey Response Functions - Functions that leverage the SurveyGizmo API to list, add, remove, and replace survey responses.

Email Campaign & Action Functions - Functions that allow for managing Email Campaign contacts and sending emails within a response.

PDF Functions - Functions for building PDFs within a response. Often paired with email action functions.

Miscellaneous Functions - This mixed bag of functions allows for things like checking whether a question is answered or submitting the survey response.

Lua Functions - A select set of Lua functions that you can leverage in scripts.

PHP Functions - A select set of PHP functions that you can leverage in scripts.

Important Info to Get Started Scripting

Custom Script actions are processed in order (with questions) from the top of the page to the bottom when the page is rendered. To affect a question on the same page as the script it will need to precede the question on the page.
Lua can be used as documented! See Lua Docs: https://www.lua.org/docs.html

What Can I Do With Custom Scripting?

The possibilities are vast. Check out our Working Examples of Custom Scripting.