メインコンテンツへスキップ
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を追加するには、folderの種類、フォルダの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はカスケードで適用されるため、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を使用します。 使用可能なトリガーのリストは、こちらのガイドを参照してください。