フォルダへのWebhookの作成

ガイド Webhook Webhookの管理 フォルダへのWebhookの作成

フォルダへのWebhookの作成

フォルダにWebhookを追加するには、folderの種類、フォルダのID、Webhook通知の送信先URL、およびWebhookをアクティブにするトリガーのリストを指定してWebhookを作成エンドポイントを呼び出します。

cURL
curl -i -X POST "https://api.box.com/2.0/webhooks" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
       "target": {
         "id": "234234",
         "type": "folder"
       },
       "address": "https://example.com/webhooks",
       "triggers": [
         "FILE.UPLOADED"
       ]
     }'

このAPIを使用するには、アプリケーションの[webhookを管理]スコープが有効になっている必要があります。

WebhookのアドレスはHTTPS URLである必要があります。

Webhookアドレス

addressパラメータで指定する通知URLは、Webhookの作成時に指定した有効なHTTPS URLである必要があります。このURLは、いずれかのトリガーがアクティブになるたびに呼び出されます。

通知URLは標準HTTPSポート443を使用する必要があり、Webhookペイロードの受信から30秒以内に200299の範囲のHTTPステータスを返す必要があります。

Webhookトリガー

トリガーのリストでは、Webhookをトリガーするイベントを表す文字列を指定します。たとえば、ユーザーがファイルをアップロードしたときにWebhookをトリガーするには、トリガー名としてFILE.UPLOADEDを渡します。

使用可能なトリガーのリストは、このガイドにあります。