Filmsquare ヘルプドキュメント

ツールをつなぐ

テイクが完成したときにWebhookを受け取るにはどうしますか?

更新日 .md

このページの内容
  1. 登録する
  2. イベント
  3. 検証と応答

Webhookは、テイクが完成したとき、テイクが採用されたとき、新しいバージョンが届いたときに、あなたのURLにイベントを送ります。ポーリングする必要はありません。Webhookは、プロデューサーかオーナーが、API経由で設定します。スタジオに、そのための画面はありません。

登録する #

/v1/workspaces/{ws}/webhooksにPOSTを送り、urlと、欲しいevents(すべてなら["*"])を指定します。応答にはsecretが1回だけ含まれます。配信のたびに検証に使うので、保管してください。URLは、公開されたホストのhttpかhttpsのアドレスである必要があります。キーが必要です。APIキーの取得のしかたを参照してください。リクエストは、ドキュメントの登録にあります。

イベント #

イベントは4つです。generation.succeeded、generation.failed、take.selected、asset_version.createdです。個人のスケッチブックのテイクに関するイベントは、送られません。それぞれのフィールドは、各イベントのデータにあります。

検証と応答 #

配信にはすべて、x-fs-signatureヘッダーが付きます。sha256=に、生のボディに対する、シークレットをキーとしたHMAC-SHA256の16進が続きます。署名が一致しない配信は、拒否してください。コードは、署名を検証するにあります。

応答は、2xxのステータスで、すばやく返してください。5xx、429、タイムアウト、ネットワークエラーは、バックオフしながら、最大8回再試行されます。そのほかの4xxでは、配信が終わります。配信は、複数回届くことがあるので、処理済みのイベントを飛ばすには、x-fs-deliveryを使ってください。

メールで問い合わせる