labvanced logoLabVanced
Contact
    • Remote Physiological Measurements
    • Eye Tracking
    • Head & Face-Tracking
    • Emotion Detection
    • Heart Rate Detection (rPPG)
    • Generative AI
    • Audio Transcription
    • EEG & Hardware Integrations
    • Decision Making
    • Reaction Times
    • Keyboard Inputs
    • Mouse Tracking
    • Mobile / Touch
    • Questionnaires
    • Gamepad / Joystick Integration
    • Audio Recordings
    • Audio Transcription
    • Video Recordings
    • Screen Recordings
    • Photos / Snapshots
    • Video Conferencing
    • Canvas Drawings
    • Build with AI
    • Build with Spreadsheets
    • Using the Experiment Editor
    • Coding
    • Creating Questionnaires
    • Balancing & Randomization
    • UX & Website Testing
    • Single Session Studies
    • Factorial Designs
    • Longitudinal & Multi-session Studies
    • Individual & Case Studies
    • Real-time Multi-user Studies
    • Interviews & Video Calls
    • Surveys & Questionnaires
    • Experience Sampling & Diaries
    • Classroom & Group Testing
    • Interventions & Clinical Trials
    • In the Browser
    • Mobile App
    • Desktop App
    • WebBridge Chrome Extension
    • Stroop Test
    • Flanker Task
    • N-back Task
    • Implicit Association Test
    • Trail Making Test
    • Digit Span
    • Corsi Block Tapping
    • Tower of London
    • Balloon Analog Risk Task
    • Preferential Looking
    • Browse more →
    • DASS-21
    • GAD-7
    • Rosenberg Self-Esteem Scale
    • PHQ-9
    • Ten-Item Personality Inventory
    • Big Five Personality Test
    • Adult ADHD Self-Report Scale
    • Browse more →
    • Building a Multi-user Study
    • Webcam Eye Tracking with AOIs
    • Website Frame Eye Tracking
    • Conditional Eye Tracking Opt-in
    • ChatGPT Study
    • Desktop App Study with EEG
    • Between-subjects Group Balancing
    • Building a Reading Study
    • Stroop Task
    • Lexical Decision Task
    • Browse more →
    Public Experiment Library
    • Arts Research
    • Clinical Psychology & Neuropsychology Medicine
    • Cognitive Psychology
    • Developmental Psychology
    • Behavioral Economics & Decision Science
    • Educational Research & Psychology
    • HCI & Human Factors
    • Linguistics & Language Sciences
    • Consumer & Marketing Research
    • Social & Personality Psychology
    • Sport & Movement Science
    • UX & Website Testing
    • Executive Functions
    • Language & Reading
    • Decision-Making & Reasoning
    • Attention
    • Overview
    • HCI & Human Factors
    • UX & Website Testing
    • Consumer & Marketing Research
    • White-Label App
    • PageGazer
    • Webcam vs. Lab Eye Tracking in InfantsAnna Banki & Gabriela Markova
    • Eye Tracking for Influencer MarketingDr. Alexander Edeling
    • Eye Tracking Infant Word ComprehensionDr. Giulia Calignano
    • Sentence Reading and Grammar JudgmentsDr. Jonathan Mirault
    • Regulating Emotions with MusicDr. Katrin Starcke
    • Game-Based Grammar Learning in ChildrenDr. Mireia Marimon
    • Gaze Cueing and AutismMax Soares Miehstein
    • Personality and Hearing in NoiseDr. Malte Wöstmann
    • All interviews →
    • Lab Notes
    • How to Cite Labvanced
    • Labvanced Platform Paper (2017)
    • Webcam Eye Tracking Validation (2024)
    • Webcam Eye Tracking Studies
    • Cognitive Psychology Studies
    • Developmental Psychology Studies
    • Linguistics Studies
    • See all publications →
    • Getting Started
    • Guide
    • Video Tutorials
    • Walkthroughs
    • Live Chat
    • Webinars & Onboarding Calls
    • AI Assistant
    • FAQ
    • Importing Templates Guide
    • Test Templates
    • Live Eye Tracking Metrics
    • Mouse Tracking Demo
    • ChatGPT Demo
    • Audio Recording Object Demo
    • Adding Image Stimuli Demo
    • Score & Feedback Demo
    • Browse all technical demos →
    • Timing Precision
    • Stimuli Presentation
    • Headphone Checks
    • Bot Checks
    • Participant Management
    • Comparisons
    • Research Blog
    • Prolific Integration
    • CloudResearch Integration
    • Sona Systems Integration
    • BeSample Integration
    • Panelabs Integration
    • Clickworker Integration
    • Labvanced Webhook API
    • Labvanced REST API
    • About Us
    • Newsletter Archive
    • Terms & Conditions
    • Data Security & Data Privacy
    • Technical & Organisational Measures
    • Accessibility
    • W-8BEN-E Form
    • Data Processing Agreement Template
    LinkedInYouTubeDiscord
    • Individual
    • Lab
    • Department / Consortium
    • Teaching
    • Campus
    • Commercial
    • Browse recording top-ups →
    • Browse AI token top-ups →
    • Overview
    • Study Building
    • Subject Recruitment
    • Dedicated Support
    Checkout
  • Contact
    • EN
      • 中國人
      • Deutsch
      • Français
      • Español
      • English
      • 日本語
    • Logout
    • Loginlogin icon
    Platform
    Labvanced makes it easy to implement the most advanced study design and reliably collect your data.
    Biosignals & AI
    Remote Physiological MeasurementsEye TrackingHead & Face-TrackingEmotion DetectionHeart Rate Detection (rPPG)Generative AIAudio TranscriptionEEG & Hardware Integrations
    Behavioral Recordings
    Decision MakingReaction TimesKeyboard InputsMouse TrackingMobile / TouchQuestionnairesGamepad / Joystick Integration
    Media Recordings
    Audio RecordingsAudio TranscriptionVideo RecordingsScreen RecordingsPhotos / SnapshotsVideo ConferencingCanvas Drawings
    Implementation Techniques
    Build with AIBuild with SpreadsheetsUsing the Experiment EditorCodingCreating QuestionnairesBalancing & RandomizationUX & Website Testing
    Study Formats

    Your study can take whatever format your research needs. Here are a few popular examples.

    Single Session StudiesFactorial DesignsLongitudinal & Multi-session StudiesIndividual & Case StudiesReal-time Multi-user StudiesInterviews & Video CallsSurveys & QuestionnairesExperience Sampling & DiariesClassroom & Group TestingInterventions & Clinical Trials
    Where Studies Run

    Run your study online in the browser, on mobile or tablet with the mobile app, or in-lab with the desktop app.

    In the BrowserMobile AppDesktop AppWebBridge Chrome Extension
    Tests
    Explore cognitive tests, questionnaires, walkthroughs, and our public experiment library: a starting point for your next study.
    Popular Cognitive Tests
    Stroop TestFlanker TaskN-back TaskImplicit Association TestTrail Making TestDigit SpanCorsi Block TappingTower of LondonBalloon Analog Risk TaskPreferential Looking
    Browse more →
    Questionnaires & Scales
    DASS-21GAD-7Rosenberg Self-Esteem ScalePHQ-9Ten-Item Personality InventoryBig Five Personality TestAdult ADHD Self-Report Scale
    Browse more →
    Public Experiment Library

    Take a look at what other researchers in the community are doing through our extensive, open catalog of shared studies.

    Open the public library →
    Walkthroughs

    Step-by-step builds of complete studies, from a blank project to a running experiment, that you can follow along or adapt.

    Building a Multi-user StudyWebcam Eye Tracking with AOIsWebsite Frame Eye TrackingConditional Eye Tracking Opt-inChatGPT StudyDesktop App Study with EEGBetween-subjects Group BalancingBuilding a Reading StudyStroop TaskLexical Decision Task
    Browse more →
    Research
    One platform for students, academics, and industry researchers studying human behavior.
    Harvard UniversityStanford UniversityCambridge UniversityUCLNYUMax Planck InstituteUCLATU Munich

    Trusted by researchers at 1,500+ universities worldwide

    Academic Research
    Arts ResearchClinical Psychology & Neuropsychology MedicineCognitive PsychologyDevelopmental PsychologyBehavioral Economics & Decision ScienceEducational Research & PsychologyHCI & Human FactorsLinguistics & Language SciencesConsumer & Marketing ResearchSocial & Personality PsychologySport & Movement ScienceUX & Website Testing
    Research Areas
    Executive FunctionsLanguage & ReadingDecision-Making & ReasoningAttention
    Industry / Commercial
    OverviewHCI & Human FactorsUX & Website TestingConsumer & Marketing ResearchWhite-Label AppPageGazer
    Researcher Interviews

    Conversations with researchers about the studies they ran with Labvanced, what worked, and what they learned.

    Webcam vs. Lab Eye Tracking in InfantsAnna Banki & Gabriela MarkovaEye Tracking for Influencer MarketingDr. Alexander EdelingEye Tracking Infant Word ComprehensionDr. Giulia CalignanoSentence Reading and Grammar JudgmentsDr. Jonathan MiraultRegulating Emotions with MusicDr. Katrin StarckeGame-Based Grammar Learning in ChildrenDr. Mireia MarimonGaze Cueing and AutismMax Soares MiehsteinPersonality and Hearing in NoiseDr. Malte Wöstmann
    All interviews →
    Our Research
    Lab NotesHow to Cite Labvanced
    Peer Reviewed Studies

    A selection of peer-reviewed work built on Labvanced: our own platform and validation papers, and studies by the research community grouped by area. Hundreds more are listed on the full publications page.

    Labvanced Platform Paper (2017)Webcam Eye Tracking Validation (2024)Webcam Eye Tracking StudiesCognitive Psychology StudiesDevelopmental Psychology StudiesLinguistics Studies
    See all publications →
    Resources
    Valuable resources to help you learn the platform, stay updated, and more.
    Documentation
    Getting StartedGuideVideo TutorialsWalkthroughs
    Support
    Live ChatWebinars & Onboarding CallsAI AssistantFAQ
    Templates & Demos

    These are a few popular examples. Browse our guide and a selection of technical demos to get started with implementation.

    Importing Templates GuideTest TemplatesLive Eye Tracking MetricsMouse Tracking DemoChatGPT DemoAudio Recording Object DemoAdding Image Stimuli DemoScore & Feedback Demo
    Browse all technical demos →
    Methodology
    Timing PrecisionStimuli PresentationHeadphone ChecksBot ChecksParticipant ManagementComparisonsResearch Blog
    Integrations & APIs
    Prolific IntegrationCloudResearch IntegrationSona Systems IntegrationBeSample IntegrationPanelabs IntegrationClickworker IntegrationLabvanced Webhook APILabvanced REST API
    Company & Legal
    About UsNewsletter ArchiveTerms & ConditionsData Security & Data PrivacyTechnical & Organisational MeasuresAccessibilityW-8BEN-E FormData Processing Agreement Template
    LinkedInYouTubeDiscord
    Pricing
    Our licenses and additional services at a glance.
    Licenses
    IndividualLabDepartment / ConsortiumTeachingCampusCommercial
    Top-Ups

    Need more recordings for your lab or your own research? Simply use one of these recording top-up packages.

    Browse recording top-ups →

    Need more AI tokens for the AI assistant and study translations? Simply use one of these AI token top-up packages.

    Browse AI token top-ups →
    Additional Services

    Hire Labvanced’s expert team to quickly bring your project to the level of rigor it needs.

    OverviewStudy BuildingSubject RecruitmentDedicated Support
    Checkout

    Ready to purchase a license or top-up? Head straight to checkout.

    Go to checkout →
    • 中國人
    • Deutsch
    • Français
    • Español
    • English
    • 日本語
    • Getting Started
    • Guide
      • GETTING STARTED

        • Task Editor
        • Frames
          • Canvas Frame
          • Page Frame
          • Website Frame
          • Overlays & Dialogs | Labvanced
        • Trial Timeline
        • Stimulus Presentation
        • Correctness of Response
        • Objects
        • Events
        • Variables
        • Task Wizard
        • AI Assistant
        • Trial System
        • Experiment Design
          • Creating a Study
          • Importing Templates in Labvanced
          • Data Frame Patterns
          • Multi-user Experiment Design
          • Longitudinal Experiment Design
      • FEATURED TOPICS

        • Randomization & Balance
        • Eye Tracking
          • Presenting Stimuli in an Eye Tracking Task
          • How to Choose Eye Tracking Calibration Settings
          • Setting Up Eye Tracking in a Task
          • Recording and Exporting Gaze Data
          • Using Shapes as Areas of Interest (AOI) for Eye Tracking
          • The Participant Calibration Experience
        • Web Bridge
          • Selecting Website AOIs | Anchor, Adjust, and Verify AOI Tracking
          • Tracking Mouse Behavior on a Website AOI | Web Bridge Guide
        • Questionnaires
        • Desktop App
        • Sample Studies
        • Participant Recruitment
        • API Access
          • REST API
          • Webhook API
          • WebSocket API
        • Other Topics

          • Precise Stimulus Timings
          • Multi User Studies
          • Head Tracking in Labvanced | Guide
      • MAIN APP TABS

        • Overview: Main Tabs
        • Dashboard
        • My Studies
        • Shared Studies
        • My Files
        • Experiment Library
        • My Account
        • License & Services
      • STUDY TABS

        • Overview: Study-Specific Tabs
        • Study Design
          • Tasks
          • Blocks
          • Sessions
          • Groups
        • Task Editor
          • Task Controls
          • The Trial System
          • Frame Types
          • Objects
          • Object Property Tables
          • Variables
          • System Variables Table
          • The Event System
          • Text Editor Functions
          • Eye Tracking Options in the Task Editor
          • Head Tracking in a Task
          • Multi-User Studies
        • Settings
        • Variables
        • Media
        • Texts & Translate
        • Launch & Participate
        • Subject Management
        • Dataview and Export
    • Video Tutorials
      • Video Overview
      • Getting Started in Labvanced
      • Creating Tasks
      • Element Videos
      • Events & Variables
      • Advanced Topics
    • Walkthroughs
      • Introduction
      • Stroop Task
      • Lexical Decision Task
      • Posner Gaze Cueing Task
      • Change Blindness Flicker Paradigm
      • Eye-tracking Sample Study
      • Infant Eye-tracking Study
      • Attentional Capture Study with Mouse Tracking
      • Rapid Serial Visual Presentation
      • ChatGPT Study
      • Eye Tracking Demo: SVGs as AOIs
      • Multi-User Demo: Show Subjects' Cursors
      • Gamepad / Joystick Controller- Basic Set Up
      • Desktop App Study with EEG Integration
      • Between-subjects Group Balancing and Variable Setup
      • Building a Multi-user Study
      • Website Frame Eye Tracking Walkthrough
      • Conditional Webcam Eye Tracking
      • Text Segmentation Study Building
      • Building a Study with AI
    • FAQ
      • Features
      • Support Policy & Guidelines
      • Security & Data Privacy
      • Licensing
      • Precision of Labvanced
      • Programmatic Use & API
      • Using Labvanced Offline
      • Troubleshooting
      • Study Creation Questions
    Websocket Trigger receiving a message from an external device in Labvanced

    Websocket Trigger

    The Websocket Trigger fires when your running study receives a message over its WebSocket connection. It lets a local script, a recording device, or an external server start an event in your study at the moment something happens outside the browser.

    Table of Contents

    • Overview
    • How It Works
    • Trigger-Specific Values
    • Workflow Tips
    • Studies & Example Scenarios

    Overview

    The Websocket Trigger is listed under the API/External Trigger category in the trigger selection menu. Together with the Send to Websocket Action, it gives a study two-way communication with software running outside Labvanced.

    Common Use Cases

    The Websocket Trigger is used wherever a signal from outside the study should change what happens in the study.

    • Receiving LSL markers: a local Python script passes a marker from another Lab Streaming Layer device into the study, so the study can record it next to its own timestamps. See EEG & Hardware Integrations for the full picture.
    • Closed-loop and biofeedback designs: a script that processes a physiological signal sends a message whenever a threshold is crossed, and the study changes the stimulus in response.
    • External processing: a server analyzes data sent from the study and returns a result, such as a classification or a score, that the study then displays or records.

    How It Works

    To access the Websocket Trigger, open the Event System in the Task Editor and create a new event. Under the API/External Trigger category, select Websocket Trigger.

    Before the trigger can be used, enable the connection in the study settings:

    1. Open the Settings tab.
    2. Open the Special Features drop-down and find the Websocket Connection section.
    3. Check the option to enable it, then enter the WebSocket Address and the Port. The defaults are ws://localhost and 8081, which connect to a script running on the same computer as the study.

    The dialog contains the following:

    OptionDescription
    Websocket AddressShows the address from your study settings. It cannot be edited here.
    PortShows the port from your study settings. It cannot be edited here.
    trigger / messageThe message label that fires this event. The trigger fires when the label of an incoming message matches this text exactly. Enter any to fire on every incoming message.

    When the study starts, Labvanced opens the connection to the address and port you entered. If the connection is not enabled in the settings, no connection is opened and the trigger never fires.

    The trigger listens only while the frame that contains the event is displayed. A message that arrives while a different frame is displayed does not start this event. Put the event on every frame where the study should react to the message.

    An event with any fires for every message. If another event on the same frame uses a specific label, both events fire when a message with that label arrives.

    What the Sending Program Provides

    The trigger only fires if a program outside Labvanced sends it a message. That program, usually a short script on the same computer, runs the WebSocket server that the study connects to. Each message it sends has two parts:

    • A label: the trigger compares it with the trigger / message field. When they match, the event fires, and the label is available as the Message value.
    • Content: any value the script wants to pass along, such as a marker value or a measurement. It is available as the Data value.

    For the person writing the script, each message is a JSON object with the fields msg for the label and value for the content. The example scripts in the Labvanced WebSocket API repository on GitHub send and receive LSL markers this way and are a good starting point. For the connection setup, see the WebSocket API guide.

    Trigger-Specific Values for Websocket Trigger

    After the trigger fires, the following values are available in the actions of the event. Select them through the Value-Select Menu under Trigger (Websocket Trigger).

    ValueDescription
    MessageThe label of the received message. Use it to tell message types apart, especially in an event that uses any.
    DataThe content of the received message. It can hold any JSON value, such as a number, a string, or a list, and can be stored in a variable with the Set / Record Variable Action.
    Trigger Timestamp (Unixtime)The time at which the trigger fired, in Unix time with milliseconds.
    Trigger Time (From Frame Onset)The time in milliseconds from the start of the frame to the moment the trigger fired.

    Workflow Tips

    • Start your script before you start the study. The connection is opened when the study starts.
    • Test the connection with the study running on the same computer as the script before you collect data. The default ws://localhost only reaches programs on that computer.
    • Keep message labels short and consistent between the script and the study. The match is exact, so Marker and marker are different messages.
    • Record Trigger Time (From Frame Onset) together with Data when the timing of the message matters for analysis.

    Studies & Example Scenarios

    Receiving a marker from another device. In the LSL Receive Marker library study, a marker produced by an external device reaches a local Python script, which passes it to the study through a Websocket Trigger. The study then records the marker value. Use the Inspect option in the library to see the event setup.

    Two-way messaging. The Socket Connection Example library study sends a message out of the study with the Send to Websocket action and reacts to the replies with this trigger.

    Further Reading

    Send to Websocket Action

    Send to Websocket Action

    The paired action for sending a message or a variable out of the study.

    WebSocket API

    WebSocket API

    How to connect a study to a local script or an external server.

    Value Select Menu

    Value Select Menu

    How to reference trigger-specific values in your actions.

    Events Overview

    Events Overview

    A full introduction to the trigger-and-action logic system in Labvanced.