Webhook

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

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

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

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:00"

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

created_byユーザー (Mini) object

Webhookを作成したユーザー

target object

Webhookをトリガーする項目

target.id string

例"1231232"

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

target.type string

例"file"

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

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

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