- Webhook を簡単に、安全に、安定して配信するためのオープンソースのツールとガイドライン
- Zapier、Twilio、ngrok、Supabase、Kong などのエンジニアが技術運営委員会を構成
- Standard Webhooks の紹介
- Webhook はますます一般的になっており、世界有数の企業で自社 API ユーザーにイベントを送信するために使われている
- しかし Webhook プロバイダーごとに実装方式が異なり、品質にもばらつきがあるなど、エコシステムは細分化されている
- 高品質な実装であっても多様であるため本質的に互換性がなく、この断片化はプロバイダーとコンシューマーの双方にとって負担であり、イノベーションを妨げている
- コンシューマーの立場では、プロバイダーごとに Webhook の扱い方が異なり、Webhook を検証する方法も毎回学び直す必要があり、カスタム実装によって問題が発生することもある
- プロバイダーの立場では、すでに解決されている問題（セキュリティ、旧バージョンとの互換性など）について再設計しなければならないことを意味する
- 私たちは業界全体で Webhook を標準化するシンプルなソリューションを提案する
- このデザイン文書では、既存の業界ベストプラクティスに基づいた厳格な Webhook ガイドラインを提案し、これを「Standard Webhooks」と呼ぶ
- 「Standard Webhooks」は、JWT が API 認証にもたらしたことを Webhook に対しても実現できると考えている
- 一貫性があり多様な実装でサポートされる共通プロトコルを採用することで、上記の問題を解決し、Webhook エコシステムにおける新しいツールとイノベーションを可能にする
- そのために私たちは、Webhook 配信のためのオープンソースかつコミュニティ主導のツールとガイドラインを作成した
- 設計目標: セキュリティ、信頼性、相互運用性、シンプルさ、旧バージョンおよび将来のバージョンとの互換性
- Payload は HTTP Body に入れて送信し、JSON で構成される。最大サイズの制限はないが、20kb 以下を推奨
- Webhook の真正性確認のためにメタデータおよび Signature Scheme を定義
まだコメントはありません。