Box Developerドキュメント
ログイン

Webhook

このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 **Box APIのバージョン管理**を参照してください。

設定されたWebhookを表します。

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

string
11446498

このWebhookの一意の識別子。

string
webhook

値は常にwebhookになります。

次の値に固定: webhook

string
https://example.com/webhooks

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

string (date-time)
2012-12-12T10:53:43-08:00

Webhookが作成された日時を示すタイムスタンプ。

ユーザー (Mini) object

Webhookを作成したユーザー。

object

Webhookをトリガーする項目。

string
1231232

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

string
file

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

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

string array
["FILE.UPLOADED"]

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

レスポンスの例

{
  "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"
  ]
}