制限

Webhookは1項目につき1つ

Webhookは、1人の認証済みユーザーの1つのアプリケーションで、1つの項目 (ファイルまたはフォルダ) につき1つだけという制限があります。

ある項目にWebhookを1つ追加した後は、たとえ別のトリガーイベントに応答するWebhookであっても、2つ目を追加することはできません。

たとえば、CleanupAppというアプリケーションに関するJunkというフォルダ内のFILE.UPLOADEDイベントを監視するように、John DoeによってWebhookが1つ設定されているとします。その時点で、FILE.DOWNLOADEDイベントに対してトリガーされるものであっても、John DoeによってCleanupAppがJunkフォルダに2つ目のWebhookを追加することはできません。

別のイベントをリッスンするには、既存のWebhookを更新するか、新しいアプリケーションを作成します。

1つのアプリケーション、1人のユーザーあたり1000個のWebhook

1つのアプリケーション、1人のユーザーあたりのWebhookの数は1,000個までという制限があります。

1人のユーザーにさらにWebhookを作成するには、別のアプリケーションを作成するか、フォルダツリーでより上位に適用するよう既存のWebhookを更新します。

通知URLに関する制約事項

Webhookの通知URL (address) は、有効なIPアドレスに解決される有効なHTTPS URLでなくてはなりません。さらに、Boxでは自己署名SSL証明書がサポートされていないため、信頼できる認証局によって署名された証明書が必要になります。

サーバーのIPアドレスは、インターネットからパブリックにアクセスできる必要があり、(*.)box.comアドレスにすることはできません。URLで使用されるポートは、標準HTTPSポート (443) でなければなりません。通知は他のポートには配信されません。

Webhookはルートフォルダに追加不可

V2 Webhookをルートフォルダ (IDが0のフォルダ) に作成することはできません。代わりにV1 Webhookを使用する必要があります。

Webhookの削除理由

Webhookは以下の理由で削除される可能性があります。

1. Boxアプリケーションを削除すると、そのアプリケーションに関連付けられているすべてのWebhookが自動的に削除されます。
2. Webhookに関連付けられているアクティブなアクセストークンをすべて削除すると、そのWebhookが自動的に削除されます。これには、開発者トークンとパスワードが含まれます。
3. 最後に成功した配信から30日が経過し、最後に配信が成功した日から最後のトリガーの日付までの期間が14日を超えた場合、Webhookは自動的に削除されます。

これらのすべてのケースで、BoxはWEBHOOK.DELETEDイベント名を含むWebhookペイロードを通知URLに送信します。ペイロードの本体には以下の追加情報が含まれます。

"additional_info": {
  "reason": "auto_cleanup"
}