Webhook - Box Dev Docs

APIバージョン 2024.0 設定されたWebhookを表します。

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

string

例 11446498このWebhookの一意の識別子。

type

string

例 webhook値は常にwebhookになります。次の値に固定: webhook

address

string

例 https://example.com/webhooksこのWebhookによって通知されるURL。

created_at

string(date-time)

例 2012-12-12T10:53:43-08:00Webhookが作成された日時を示すタイムスタンプ。

created_by

ユーザー (Mini)object

Webhookを作成したユーザー。

target

object

Webhookをトリガーする項目。

表示子属性

string

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

type

string

例 fileWebhookをトリガーする項目のタイプ。次の値のいずれか1つ: file,folder

triggers

stringarray

例 ["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": "[email protected]",
    "name": "Aaron Levie"
  },
  "target": {
    "id": "1231232",
    "type": "file"
  },
  "triggers": [
    "FILE.UPLOADED"
  ]
}