Message events

introduction to keep your app informed about the user's progress within the plug in, we transmit data via message events at various stages this page describes the different types of events, when they are sent, and their data format the events are in json format and contain information about the face scan's progress prerequisites make sure you've first gone through the initial integration docid\ qghldn2mla8w9rpkeigwn documentation, which explains the key concepts and explains the health check flow to learn how to listen for these data messages in web apps, refer to the listening to message events docid 1phy94phttsvfmacmkepv page overview we currently distinguish the following events startnewmeasurement recordingstarted recordingstopped facescansuccessful userfinished dismiss summary of event occurrences upon reaching the recording screen, where the actual face scan takes place, users are welcomed by the smart assistant after confirming they are at rest, the initial quality check kicks in if the conditions are favourable and the check passes, the actual recording starts and a recordingstarted event is sent the progress bar starts running, and once all results are in, the measurement succesfully concludes, prompting a recordingstopped event a modal appears to inform the users about the completion of the scan clicking on 'continue' triggers the final facescansuccessful and dismiss events there might be instances where the quality deteriorates too much during the face scan, rendering an accurate assessment unfeasible for instance, this could occur if the lighting abruptly dims if this situation drags on for too long, users are presented with two choices they can restart the face scan by selecting the ‘ try again ’ option, or they can opt to conclude the face scan without completing it successfully by clicking the ‘ quit ’ button choosing the 'try again' option brings them back to the start of the face scan process if they select the 'quit' option, no biomarkers can be calculated and a userfinished event will be sent, along with a dismiss event in short the dismiss event indicates the plug in iframe may be closed (dismissed) this may be due to either succesful completion of the face scan – in which case it will be accompanied by a facescansuccessful – or, another reason, e g the user chose to quit – in which case it will be accompanied by the userfinished event the event types are further explained in detail below event types the diagram below illustrates the different stages within the plug in and the corresponding events triggered any other message events not mentioned in this documentation, may be send for diagnostic or test purposes and should not be used recording started sent when the user clicks the record button and the timer starts event data success { "stage" "recordingstarted", "uuid" "380cae2a32ed4023be60a63c3ee97e95", } stage "recordingstarted" uuid face scan id (unique id of the face scan) recording stopped sent when the recording stopped, i e the recording timer ends event data success { "stage" "recordingstopped", "uuid" "380cae2a32ed4023be60a63c3ee97e95", } stage "recordingstopped" uuid face scan id (unique id of the face scan) face scan successful sent when the result are available and can be requested via the api you can use this to close the iframe after the measurement completes event data success { "stage" "facescansuccessful", "uuid" "380cae2a32ed4023be60a63c3ee97e95", "data" {} // rfu } stage "facescansuccessful" uuid face scan id (unique id of the face scan) data reserved for future use user finished send when the user decides to quit the face scan without succesfully completing the measurement for example by clicking the cross sign and choosing 'quit' by quitting the flow when e g the lighting conditions are not good (a not choosing for the 'try again' option) this allows you to handle this path differently in your user journey event data json { "stage" "userfinished", "data" { } // rfu } stage "userfinished" data reserved for future use dismiss we will notify you with a "dismiss" event when the plug in can be closed (dismissed) this is an overarching event, covering any situation where the plug in should be closed it is always accompanied by a facescansuccessful or userfinished event, which clarify the path the user followed sent when the web plugin should be closed event data json { "stage" "dismiss", "data" { } // rfu } stage "dismiss" data reserved for future use