osFoundry / Platform
送信ウェブフック
プラットフォームイベントを自分のエンドポイントへ送出。自動リトライ、署名検証付き。
概要
アウトバウンドWebhookを使うと、osFoundryが発生させたイベントを、あなたが管理するエンドポイントへプッシュできます。変更を検知するためにポーリングを繰り返す代わりに、URLを一つ登録しておけば、ワークスペースで関連するイベントが起きるたびに、osFoundryがそのURLへHTTPリクエストを送ります。これにより、チャットやエージェント、アプリ、コード、ナレッジ、データといった各面での動きが、自社システムが処理できる信号になります。しかも、対象ごとに個別の連携を作り込む必要はありません。
osFoundryではWebhookを「設定とセキュリティ」の配下に置いています。ワークスペースのイベントを、あなたが所有する受信側へ持ち出す、信頼境界をまたぐ機能だからです。すべての配信には署名が付くため、そのリクエストが本当にosFoundryから来たものであり、途中で改ざんされていないことを、エンドポイント側で検証できます。ボディを信頼する前に、共有シークレットを使って署名を照合してください。エンドポイントが停止していた、応答が遅かった、あるいはエラーを返したといった理由で配信が失敗した場合も、そのまま破棄されるのではなく自動で再試行されます。受信側で短時間の障害が起きても、イベントが黙って失われることはありません。osFoundryはBYOKかつローカルファーストであり、Webhookはデータを外へ動かすための、意図的でオプトインの手段です。どのエンドポイントがイベントを受け取るかはあなたが決め、ペイロードはあなたが指定した先にしか届きません。
実際の価値は、疎結合になることにあります。通知サービスやチケット管理、データウェアハウス、あるいは社内の自動化処理は、osFoundryの内部に置く必要も、osFoundryの認証情報を持つ必要もありません。署名を検証し、成功ステータスを返すHTTPSエンドポイントを一つ用意すればよいだけです。署名検証と自動再試行があるからこそ、そのエンドポイントは信頼して依存できるものになります。これが、ワークフローの土台にできるWebhookと、常に面倒を見続けなければならないWebhookとの違いです。
主な機能
- 自社のHTTPSエンドポイントを登録し、プラットフォームのイベントを発生と同時に受け取れます。ポーリングのループを保守する必要はありません
- すべてのペイロードに署名が付くため、処理を始める前に、そのリクエストがosFoundry由来であることを受信側で検証できます
- 配信に失敗しても自動で再試行するため、下流の障害でイベントが黙って失われることはありません
- 「設定とセキュリティ」の配下で管理する、エンドポイントごとにオプトインで完全に制御できるアウトバウンド経路です
- ローカルファーストかつBYOKの設計に沿い、データは明示的に指定したエンドポイントにしか出ていきません
活用例
- プラットフォームエンジニア：osFoundryの認証情報を渡さず、アプリに組み込むこともなく、ワークスペースのイベントを社内の自動化サービスへ転送する
- 運用・オンコール担当：既存のアラートや通知の仕組みへイベントを流し込み、動きを担当者がリアルタイムに把握できるようにする
- データチーム：イベントをウェアハウスやETLのエンドポイントへ流し、ワークスペースで起きていることと外部の記録を同期させ続ける
よくある質問
Webhookのリクエストが本当にosFoundryから来たものだと、どう検証すればよいですか。
配信ごとに署名が付きます。エンドポイント側で、共有シークレットを使ってリクエストボディに対する署名を再計算し、osFoundryが送ってきた署名と照合してください。一致しない場合はリクエストを拒否します。これにより、第三者があなたのエンドポイントへイベントを偽装して送ることを防げます。
イベント発生時にエンドポイントが停止していたら、どうなりますか。
osFoundryは配信を破棄せず自動で再試行します。そのため、受信側で短時間の障害やデプロイがあっても、イベントを失うことはありません。エンドポイントは、ペイロードを受け付けた時点で成功ステータスを返すようにしてください。
Webhookを使うと、データはosFoundryが管理する場所へ送られるのですか。
いいえ。osFoundryはローカルファーストかつBYOKであり、Webhookはあなたが登録したエンドポイントへのアウトバウンドです。イベントは設定したURLにしか届かず、どのエンドポイントを存在させるかはあなたが制御します。特定のイベントを、あなたが既に所有するシステムへ動かすための、オプトインの手段です。