Webhooks リソース - Box Dev Docs

Webhookを使用すると、Boxコンテンツのイベントを監視し、イベントの発生時に任意のURLへの通知を受け取ることができます。たとえば、ファイルがダウンロードされるのを待ち、ダウンロード後に共有リンクを削除するワークフローを作成できます。

Webhook

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

属性と例

プロパティ	型	必須	説明
`id`	`string`	いいえ	このWebhookの一意の識別子。
`type`	`enum<string>`	いいえ	値は常に`webhook`になります。使用可能なオプション: `webhook`.
`target`	`object`	いいえ	Webhookをトリガーする項目。
`created_by`	ユーザー (Mini)	いいえ	Webhookを作成したユーザー。
`created_at`	`string`	いいえ	Webhookが作成された日時を示すタイムスタンプ。
`address`	`string`	いいえ	このWebhookによって通知されるURL。
`triggers`	array of `enum<string>`	いいえ	このWebhookがトリガーされるイベント名の配列。

例

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

Webhook (Mini)

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

属性と例

プロパティ	型	必須	説明
`id`	`string`	いいえ	このWebhookの一意の識別子。
`type`	`enum<string>`	いいえ	値は常に`webhook`になります。使用可能なオプション: `webhook`.
`target`	`object`	いいえ	Webhookをトリガーする項目。

例

{
  "id": "11446498",
  "type": "webhook",
  "target": {
    "id": "1231232",
    "type": "file"
  }
}

Webhooks

Webhookのリスト。

属性と例

プロパティ	型	必須	説明
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`next_marker`	`string`	いいえ	次の検索結果ページの開始場所のマーカー。 `null` を指定できます。
`prev_marker`	`string`	いいえ	前の検索結果ページの開始場所のマーカー。 `null` を指定できます。
`entries`	array of Webhook (Mini)	いいえ	Webhookのリスト。

例

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "11446498",
      "type": "webhook",
      "target": {
        "id": "1231232",
        "type": "file"
      }
    }
  ]
}

​Webhook

​Webhook (Mini)

​Webhooks

Webhook

Webhook (Mini)

Webhooks