How To Respond to Survey Closure Events

Overview

An interview can be closed in several ways:

1. The interview is Cancelled.

2. The interview is Stopped.

3. The interview is Completed.

4. The interview is Filtered.

SurveyToGo allows you to automatically execute custom script logic when any of these events occur.

This is accomplished through callback functions that can be added to the survey's Advanced Scripts section. Each callback is triggered automatically when its corresponding interview closure event occurs, allowing you to perform actions such as setting answers, saving values, updating variables, or executing other custom logic.

Example Use Case

Suppose you have a question with index 5 and you want answer index 1 to be automatically selected whenever the interview is filtered. You can add the appropriate callback function to the survey's Advanced Scripts and place the required code inside it.

When the interview is filtered, the callback will be triggered automatically and the specified action will be performed without any additional intervention from the interviewer.

Perform actions when an interview is cancelled:

An interview can be cancelled due to a code in the script (jump rule, library function), or when the interview is stopped and not saved. In both cases, the callback function "OnCancel()" is called.

 

Perform actions when an interview is stopped and saved:

When an interview is stopped and saved by the surveyor, the callback function "OnSave()" is called.

 

Perform actions when an interview is completed:

When an interview is fully completed, it is in "Submit" status, and so the callback function "OnSubmit()" is called.

 

Perform actions when an interview is filtered:

An interview can be filtered due to a rule/code in the script. In this case, the callback function "OnFilter()" is called.