Events list
The following table contains all of the events that are fired and the applicable payload. For details about each payload, see Feedback ContextData.
| Custom event name | Trigger description | Payload |
|---|---|---|
| MDigital_Invite_Displayed | Once triggered, invite displayed to user. | Form_ID |
| MDigital_Invite_Accepted | User accepted the invite. | Form_ID |
| MDigital_Invite_Declined | User rejected the invite. | Form_ID |
| MDigital_Invite_Skipped | Invite is marked as skipped in the survey editor. | Form_ID |
| MDigital_ShowForm_Called | ShowForm API called. The event is reflected differently in various platforms:
| Form_ID |
| MDigital_Button_Displayed | Fired whenever a survey with a button trigger, such as a feedback button, is displayed on a website. | Form_ID |
| MDigital_Form_Displayed | The first page of the survey has been displayed. This event is not triggered for additional pages within the survey. | Form_Type (AlwaysOn,Intercept) Form_ID |
| MDigital_Form_Page_Displayed | A page other than the first page of the survey has been displayed. Triggered for additional pages within a multi-page survey. | Form_Type (AlwaysOn,Intercept) Form_ID |
| MDigital_Form_Next_Page | In-survey forward navigation (i.e., the user moved between survey pages). | Form_Type (AlwaysOn,Intercept) Form_ID |
| MDigital_Form_Back_Page | In-survey back navigation (i.e., the user moved between survey pages). | Form_Type (AlwaysOn,Intercept) Form_ID |
| MDigital_Form_Close_Submitted | User submitted feedback. | Form_Type (AlwaysOn,Intercept) Form_ID Feedback UUID |
| MDigital_Form_Close_No_Submit | User closed displayed feedback survey without submitting the survey. | Form_Type (AlwaysOn,Intercept) Form_ID |
| MDigital_Submit_Feedback | User submitted feedback. | Form_Type (AlwaysOn,Intercept) Form_ID Feedback UUID Content |
| MDigital_Feedback_Button_Clicked | User clicked a button, displaying the survey. Typically corresponds to an always-on button, but could be a custom button. | Form_Type (AlwaysOn,Intercept) Form_ID Feedback UUID (if applicable) |
| MDigital_ThankYou_Displayed | Thank-you page was displayed. | Form_Type (AlwaysOn,Intercept) Form_ID |
| MDigital_ThankYou_Close | Thank-you page was closed. | Form_Type (AlwaysOn,Intercept) Form_ID Feedback UUID |
| MDigital_CaptureButton_Clicked | User has started the screen capture process. | Form_Type (AlwaysOn,Intercept) Form_ID Feedback UUID |
| MDigital_CaptureButton_Taken | User has taken a screen capture. | Form_Type (AlwaysOn,Intercept) Form_ID Feedback UUID |
| MDigital_CaptureButton_Cancel | User canceled the screen capture process. | Form_Type (AlwaysOn,Intercept) Form_ID Feedback UUID |
-
Each event is listened to independently so that each site can scope relevant events.
-
If you plan to develop internal logic based on survey submission, it is recommended that you set it based on the "MDigital_Submit_Feedback" event to ensure that all survey types are triggering your logic. This is especially important when you are using embedded surveys that do not broadcast the “MDigital_Form_Close_Submitted" event
