Webhook とは?

Webhook は、あるシステムが別のシステムにイベントの発生を通知するために送信する HTTP リクエストです。信頼性の高い実装では、署名を検証し、再試行に対応し、重複配信を冪等に処理します。

Webhook の仕組み

Webhook の送信側は、イベントをシリアライズして受信側が管理する HTTP エンドポイントに送信し、非同期の状態変化の通知をポーリングから切り離します。応答が失われると、送信側は処理が成功したか判断できないため、通常の配信保証は厳密に一回ではなく、少なくとも一回です。そのため、受信側は元のリクエストを認証し、イベントの識別情報を記録して速やかに受領応答を返し、負荷の高いメディア処理や業務処理を永続性のあるキューに移します。

要点

  1. 署名の対象はプロバイダーごとに厳密に定義されています。リクエストの生のバイト列とタイムスタンプに署名するものもあります。一方、Transloadit は application/x-www-form-urlencoded 通知を送信し、その signature フィールドには、transloadit フィールドの文字列そのものから算出した HMAC-SHA1 が小文字の16進数で格納されます。リプレイには適用可能な別のキーで署名される場合があるため、検証用シークレットは、想定する Assembly と Workspace に対応する信頼できるサーバー側の設定から選択してください。規則の詳細はWebhook 検証仕様を参照してください。検証対象は必ずプロバイダーが定義したペイロードとし、再シリアライズしたものを使わないでください。
  2. 時間のかかる後続処理を終えてから成功応答を返すと、タイムアウトと再試行が増えます。受領応答の前にイベントを永続化すれば、その後の処理を非同期で続行できます。
  3. 再試行によってイベントが重複したり、順序が入れ替わったりすることがあります。そのため、副作用を制御するには、エンドポイントへの呼び出しを毎回一意とみなすよりも、イベント識別子と現在のリソースバージョンを使う方が安全です。

Webhook が役立つ場面

Webhook を使うと、非同期のメディア処理が完了または失敗したときに、アプリケーションのロジックを続行できます。受信側はリクエストを認証し、送信側がイベントを再試行しても副作用を重複して発生させないようにする必要があります。

メディアの知識を実用的なパイプラインに

単一の宣言的 API で、アップロード、処理、AI、ストレージ、配信を連携できます。エンコードスタックの管理、スケーリング、形式の変化への対応はお任せください。

Transloadit を無料で試す