Webhookは、特定のイベントが発生するたびに、アプリケーションが他のシステムやアプリケーションにリアルタイムデータを送信するための方法です。イベントデータを含むHTTP POSTリクエストを指定のURLに送信することで、システム間の通信を可能にします。APIからデータを引き出す従来のAPIリクエストとは異なり、Webhookはイベントによってトリガーされると自動的にデータをプッシュします。
RICOH Spacesプラットフォームでは、WebHookユーザーが3つの主要なエンティティ（予約、リクエスト、ジョブ）のデータ変更を購読することができます。WebHookコンシューマーはこれらのエンティティの変更をサブスクライブし、サードパーティAPIで受信し、RICOH Spacesエコシステムの外部で外部ロジックを実行することができます。
どのように
エンドポイントを設定する：
RICOH SpacesからのHTTP POSTリクエストを受け取る、一般にアクセス可能なURLを作成します。
エンドポイントが設定されたら、必要なセキュリティ対策を追加する必要があります。RICOH Spacesは現在、認証なし、トークン認証、カスタムヘッダをサポートしています。
受信データを処理する：
エンドポイントはリクエストからデータを解析する必要があります（通常はJSON形式）。データは多くの場合、予約、リクエスト、ジョブの更新のようなイベントに関連する情報を含んでいます。
WebHook が RICOH Spaces 内で設定されると、自動的にデータを受信し始めます。この時点で、データストリームを利用したカスタム機能の開発を開始できます。
なぜ
RICOH Spacesのユーザーは、追加統合やカスタムレポートなどのカスタムタスクを実行するためにデータをエクスポートしたい場合があります。WebHookを利用することで、RICOH Spacesのエンジニアでなくても、技術的な知識があればカスタム機能を作成することができます。
データ構造
RICOH SpacesのWebhookを使用すると、特定のイベントタイプを購読し、関連するデータを受信することができます。ここでは、サブスクライブ可能なエンティティタイプ、予約、リクエスト、ジョブについて説明します。
予約エンティティ
RICOH Spacesでは、座席、駐車場、ロッカー、会議室などの異なるスペースタイプに対して予約を見つけることができます。RICOH Spaces WebHookは、座席、駐車場、ロッカーの予約を監視することができます。予約タイプはデータの "bookingType "プロパティを介して見つけることができます。
次のフィールドは、Bookings Webフックのペイロードで使用できます：
|
リクエスト・エンティティ
リクエストは会議室予約に対して行うことができ、リクエストは予約に関する情報と、予約の一部としてリクエストされたジョブに関する情報を保持します。
|
ジョブエンティティ
例えば、ケータリングの準備、備品の配送、会議室のレイアウト変更などです。
|
来訪主体
来訪とは、来訪者がRICOH Spacesの各ロケーションに通う1回の日時のことです。また、来訪には来訪者の情報も含まれます。
|
結論
WebHookは、RICOH Spacesをご利用のお客様が独自のカスタム機能でRICOH Spaces製品を拡張する方法を提供します。独自のインテグレーションを開発したり、カスタムレポートを実行するためにデータを消費したりすることができます。WebHookを適切に利用することで、イベントドリブンな更新をスムーズに処理し、システムの同期を確保し、ライブデータに基づいてアクションを実行することができます。