You can configure webhooks on your device through the CLUe portal to receive real-time webhook events from the device when specified events occur. This enables use cases such as:

  • Integration with attendance record systems

  • Detection of spoof face events

and other real-time event-driven integrations with your system.

Supported Device

  • Device: BioStation 3 

  • Model: BS3-DB, BS3-APWB

  • The following CLUe-supported devices are also planned for webhook support:

    • W3, N2, XS2, XP2.

Firmware Version

  • File Name: bs3-all_v1.1.0_20250626_00100CL.bin

Key Benefits

  • Real-time event notifications from the device

  • Easy integration with external systems via webhooks

  • Supports use cases including HR attendance linkage and security event monitoring


Webhook Setup Guide

Location: Place > Device Menu 


Note

If the webhook configuration option is not visible, please check the CLUe firmware version on your device and update it to the version specified above or a higher version.



1. Method

The webhook uses the POST method by default.


2. Endpoint Configuration

While the device is online, configure the endpoint URL where the device will send real-time webhook calls upon specified events.

Offline event endpoint setup means of sending offline events in list format when the device is returned to online 


3. Header Configuration

Set any required keys or authentication values in the request header as needed for your webhook server.



4. Specify Trigger Events

Select the events that will trigger webhook calls.
In addition to the default selected events, you can also choose events such as spoof face detection.



5. Configure Webhook Fields

Configure the webhook fields to define which data will be sent from the device.

  • Auto Fields: These represent the types of data sets that the device can send.

  • nonString: Refers to data types such as Boolean and int, which are not enclosed in quotation marks ("").

Select the required data fields from these options and verify them using the preview function.

If you need to include additional fixed values, you can add them using Manual Fields. These values will be sent as fixed values along with the webhook payload.



6. Perform Test Call

Once the settings are complete, you can perform a test call.

Note: This test call allows you to verify the structure and format of the data that will be sent to the configured endpoint directly from the browser, not from the actual device.



Additional Note

Webhook tests can be performed even if your server is not yet ready by using publicly available webhook testing services on the internet.

For example, you can easily verify webhook calls using: