Webhook - Box Dev Docs

Webhookを使用すると、Boxコンテンツのイベントを監視し、イベントの発生時に任意のURLへの通知を受け取ることができます。たとえば、ワークフローには、共有リンクを削除するためのファイルダウンロードの待機が含まれる場合があります。このファイルにWebhookを設定すれば、ダウンロードイベントが通知されたときに、スクリプトが起動し、共有リンクを削除するためのAPIコールを実行できます。

開発者コンソールのWebhook

バージョン

WebhookにはV1とV2の2種類があります。この2つの比較を以下に示します。

使いやすさ、セキュリティの強さ、選択できるイベントトリガーの多さ、自動的に再試行されるという観点から、V2 Webhookを使用することをお勧めします。

V1	V2
開発者コンソールで作成。	開発者コンソールまたはAPIコールで作成。
ルートレベルに設定。	特定のファイル/フォルダに設定 (ただしルートには設定不可)。
14のイベントトリガーから選択。	30以上のイベントトリガーから選択。
選択したコールバックパラメータを提供。	ペイロードに、オブジェクトレスポンスと追加のコンテキスト情報がすべて含まれる。
通知配信の失敗後の再試行メカニズムなし。	通知配信の失敗後、5回まで再試行可能。
ペイロード検証をサポートしない。	ペイロード検証をサポート。
通知URLはHTTPまたはHTTPSを指定可。	通知URLはHTTPSのみ指定可。
拡張性が低い。	拡張性に優れ、信頼性が高い。

簡単な例

ファイルがダウンロードされたときにエンドポイントに通知するV2 Webhookを作成します。

curl -X POST https://api.box.com/2.0/webhooks \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "target": { "id": "FILE_ID", "type": "file" },
    "triggers": ["FILE.DOWNLOADED"],
    "address": "https://example.com/webhook"
  }'

最終更新日 2026年11月4日