概要

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

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

現時点で提供しているイベントは録音・録画のイベント（録音・録画の開始、終了など）のみとなっておりますが、今後の機能追加でRoomのイベント（Roomの作成、Memberの参加、StreamのPublish、PublicationのSubscribeなど）を2025年度中に提供予定です。

ユースケース

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

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

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

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

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

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

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

利用の流れ

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

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

通信要件

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