デバイス Webhook 設定
CLUe ポータルで Webhook を設定すると、指定したイベントが発生したときに、デバイスが指定したエンドポイント（外部サーバー）へリアルタイムイベントを送信します。 この機能で、次のユースケースを実現できます。
-
勤怠管理システムとの連携
-
重複顔検出イベントの受信
ほかにも、システムとのさまざまなリアルタイムイベント連携に活用できます。
対応デバイス
| デバイス | モデル | 対応ファームウェアバージョン |
|---|---|---|
| BioStation 3 | BS3-DB, BS3-APWB | bs3-all_v1.1.0_20250626 以降 |
次の CLUe 対応デバイスでも Webhook をサポートする予定です。
- BioEntry W3, BioLite N2, X-Station 2, XPass 2
主な利点
-
デバイスのリアルタイムイベント通知を外部システムへ送信できます。
-
Webhook を通じて外部システムと簡単に連携できます。
-
勤怠連携、セキュリティイベント監視などのユースケースをサポートします。
Webhook 設定
-
CLUe Webポータルにログインしてください。
-
Webhook を設定するデバイスが割り当てられたスペースに移動してください。
-
画面左側のサイドバーで 端末 をクリックしてください。
-
デバイス一覧から Webhook を設定するデバイスを選択してください。
-
画面上部の webhook タブをクリックしてください。
webhook タブが表示されない場合は、デバイスの CLUe ファームウェアバージョンを確認し、対応するファームウェアバージョン以降 に更新してください。
メソッド
Webhook は既定で POST メソッドを使用します。
エンドポイント（URL）設定
-
オンラインイベント: デバイスがオンライン状態のときに指定したイベントが発生すると、リアルタイムの Webhook 呼び出しを送信するエンドポイントです。
-
オフラインイベント: デバイスがオフライン状態から再びオンライン状態に切り替わると、その間に発生したイベントを一覧形式で送信するエンドポイントです。
Webhook フィールドの構成
デバイスが送信するデータを定義するには、Webhook フィールドを構成してください。
-
自動フィールド: デバイスが送信できるデータセットの種類を示します。
-
nonString: Boolean、int のように引用符（
""）で囲まないデータ型を指します。
必要なデータフィールドを選択した後、プレビュー パネルで Webhook ペイロードを事前確認できます。
追加で固定値を含める必要がある場合は、手動フィールド で追加できます。 この値は Webhook ペイロードと一緒に固定値として送信されます。
テスト呼び出しの実行
設定が完了したら、テストコール を実行できます。
テスト呼び出しでは、実際のデバイスではなく、ブラウザーから直接設定したエンドポイントに送信されるデータの構造と形式を確認できます。
参考
サーバーがまだ準備されていなくても、インターネット上で公開されている Webhook テストサービスを使って Webhook テストを実行できます。 たとえば、Webhook.site を使って Webhook 呼び出しを簡単に確認できます。
