Webhookを作成

post
https://api.box.com/2.0
/webhooks/

Webhookを作成します。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

リクエスト本文

string本文内必須
https://example.com/webhooks

このWebhookによって通知されるURL

object本文内

Webhookをトリガーする項目

string本文内必須
1231232

Webhookをトリガーする項目のID

string本文内必須
file

Webhookをトリガーする項目のタイプ

次の値のいずれか1つ: file,folder

string array本文内必須
["FILE.UPLOADED"]

このWebhookがトリガーされるイベント名の配列

レスポンス

application/jsonWebhook

新しいWebhookオブジェクトを返します。

パラメータが正しくなかった場合は、エラーを返します。

アプリケーションにWebhookを管理する権限が付与されていない場合は、エラーを返します。

ターゲット項目が見つからなかった場合は、エラーを返します

同じターゲット、アプリケーション、ユーザーの組み合わせのWebhookがすでに存在する場合は、エラーを返します。

予期しないクライアントエラー。

post
Webhookを作成
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

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": "21322",
         "type": "file"
       },
       "address": "https://example.com/webhooks",
       "triggers": [
         "FILE.PREVIEWED"
       ]
     }'

レスポンスの例

{
  "id": 11446498,
  "type": "webhook",
  "address": "https://example.com/webhooks",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "target": {
    "id": 1231232,
    "type": "file"
  },
  "triggers": [
    "FILE.UPLOADED"
  ]
}