📖 概要

本Webhookは、ロックの施錠・解錠に関するイベント発生時に、事前登録されたURLへHTTP POST形式で通知を行う仕組みです。リアルタイムで外部システムと解錠情報を連携できます。

解錠履歴Webhookにはテキスト形式とJSON形式があります。テキスト形式はSlackなどに簡単に連携するためにご利用ください。システム連携をする場合はJSON形式を推奨します。

参考:

Webhook 解錠/施錠履歴をJSON形式で取得する

Webhook 予約情報をJSON形式で取得する

Webhookをご利用頂くには、KEYVOX管理画面の右上メニューから、「開発者」を選択して開発者ポータルを開き、「Webhook」タブの「Webhookマップの追加」より連携情報を登録してください。

Untitled

Untitled

解錠履歴(テキスト形式)を選択すると、下記のライトプッシュ画面が表示されます。

image.png

対象のデバイス(ロック)を選択し、POST URLに自社システムのURLを指定してください。アクションで(すべて、解錠、施錠)を選択し、解錠手段(※)を選択するだけでインターネット経由で指定した通知を受け取ることが可能です。(自社システムをお持ちでない組織でもSlackのIncoming Webhooksを利用すればSlack上で通知を受信する事が可能です。(そのためSlackの仕様に準拠したメッセージフォーマットとなっております。)

Webhookの送信結果に関するログもメニューのログより参照可能です。

詳細は、APIとWebhookのログの確認方法 を参照ください。

※:施錠手段も含まれています。

電文仕様