メインコンテンツへスキップ
V2 Webhook は、特定のファイルまたはフォルダを監視でき、開発者コンソールでも API でも作成できます。

​
開発者コンソール

V2 Webhook を作成できるのは、[Webhook を管理する] というスコープが選択され、アプリケーションが承認されている場合のみです。必須のアクセススコープと承認の詳細を参照してください。
Webhook を作成するには、以下の手順に従います。
  1. 開発者コンソールで、目的のアプリケーションに移動します。
  2. [Webhook] タブを選択します。
  3. [Webhook を作成] ボタンをクリックします。
  4. ドロップダウンリストで [V2] を選択します。
  5. フォームに入力します。
  6. [Webhook を作成] ボタンをクリックして変更を保存します。

​
必須フィールド

フィールド名説明必須
URL アドレスWebhook によって通知される URL アドレス。はい
コンテンツタイプWebhook が構成されているコンテンツのタイプ (ファイル/フォルダ)。はい
トリガーWebhook をアクティブ化するさまざまなトリガー。はい

​
API

この API を使用するには、アプリケーションの [Webhook を管理する] スコープが有効になっている必要があります。
ファイルに Webhook を追加するには、fileの種類、ファイルの ID、Webhook 通知の送信先 URL、およびトリガーのリストを指定してWebhook を作成エンドポイントを呼び出します。 
curl -i -X POST "https://api.box.com/2.0/webhooks" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "target": {
         "id": "21322",
         "type": "file"
       },
       "address": "https://example.com/webhooks",
       "triggers": [
         "FILE.PREVIEWED"
       ]
     }'
フォルダに Webhook を追加するには、folderの種類、フォルダの ID、Webhook 通知の送信先 URL、およびトリガーのリストを指定してWebhook を作成エンドポイントを呼び出します。
Webhook はカスケードで適用されるため、Webhook を親フォルダに設定すると、サブフォルダでも選択されたトリガーが監視されます。

​
所有権

コンテンツにアクセスできなくなることで Webhook の配信に生じる可能性のある問題を回避するために、サービスアカウント (つまり削除されることのないユーザー) を使用して Webhook を作成することを強くお勧めします。 ファイルやフォルダと同様、Webhook を所有するのはユーザーです。Webhook を所有するユーザーが削除されると、以前アクセスできていたすべてのファイルとフォルダにアクセスできなくなります。ユーザーの Webhook では検証が失敗するようになりますが、Webhook サービスは引き続きイベントを送信し、再試行を要求します。

​
Webhook アドレス

addressパラメータで指定する通知 URL は、Webhook の作成時に指定した有効な URL である必要があります。この URL は、いずれかのトリガーがアクティブになるたびに呼び出されます。 通知 URL は標準ポート443を使用する必要があり、Webhook ペイロードの受信から 30 秒以内に200～299の範囲の HTTP ステータスを返す必要があります。

​
Webhook トリガー

トリガーのリストでは、Webhook によって発生するイベントを表す文字列を指定します。たとえば、ユーザーがファイルをアップロードしたときに Webhook をトリガーするにはFILE.UPLOADEDを使用します。 使用可能なトリガーのリストは、こちらのガイドを参照してください。