概要

本機能は、SkyWay で発生したイベントをユーザーのサーバーに通知する機能です。

Webhook 機能を利用すると、ユーザーのサーバーで HTTP 経由でイベント通知を受け取ることができます。

Room のイベント（Room の作成、Member の参加、Stream の Publish、Publication の Subscribe など）、録音・録画のイベント（録音・録画の開始、終了など）についてのイベント通知を提供しています。

ユースケース

次のようなユースケースでご利用いただくことを想定しています。

Room内のアクティビティをリアルタイムに監視する

• Room の作成・参加・退出、Publish・Subscribe といったイベントを Webhook で受信することで、各 Room への入室・通話開始等の状況をサーバー側から検知できます。

録音・録画の結果をリアルタイムに受け取る

従来では GetRecordingSession API をポーリングすることでしかリアルタイムの状況を取得できませんでした。Webhook を用いることで、よりリアルタイムかつレート制限に触れず、効率的に録音・録画の結果を取得できます。

イベント駆動で実行したい処理の自動化

• Room のイベントを用いて、特定のユーザーの入室に合わせて、管理システムへ通知し、参加者への自動メッセージ送信、録音・録画の開始、課金処理の開始などのシステマティックな対応が可能になります。

分析目的でのイベントログの記録

• Webhook で受信したイベントを蓄積することで、利用状況の分析やトラブルシューティングに活用できます。

利用の流れ

利用するには、Webhook のリクエストを受信するためのサーバーの実装と SkyWay コンソールでの設定が必要になります。

詳細についてはクイックスタート及び仕様をご確認ください。

通信要件

Webhook 機能の通信要件については、通信要件をご確認ください。