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

Webhook (V2) ペイロード

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

イベント発生時にWebhookアドレスに送信されるイベント。

string
11446498

このWebhook呼び出しの一意の識別子

string
webhook_event

webhook_event

次の値に固定: webhook_event

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

Webhookイベントがトリガーされた日時を示すタイムスタンプ。

ユーザー (Mini) object

このイベントをトリガーしたユーザー

File / Folder object

イベントがトリガーされる原因となった項目

string
FILE.UPLOADED

このWebhookをトリガーしたイベント名

次の値のいずれか1つ: FILE.UPLOADED,FILE.PREVIEWED,FILE.DOWNLOADED,FILE.TRASHED,FILE.DELETED,FILE.RESTORED,FILE.COPIED,FILE.MOVED,FILE.LOCKED,FILE.UNLOCKED,FILE.RENAMED,COMMENT.CREATED,COMMENT.UPDATED,COMMENT.DELETED,TASK_ASSIGNMENT.CREATED,TASK_ASSIGNMENT.UPDATED,METADATA_INSTANCE.CREATED,METADATA_INSTANCE.UPDATED,METADATA_INSTANCE.DELETED,FOLDER.CREATED,FOLDER.RENAMED,FOLDER.DOWNLOADED,FOLDER.RESTORED,FOLDER.DELETED,FOLDER.COPIED,FOLDER.MOVED,FOLDER.TRASHED,WEBHOOK.DELETED,COLLABORATION.CREATED,COLLABORATION.ACCEPTED,COLLABORATION.REJECTED,COLLABORATION.REMOVED,COLLABORATION.UPDATED,SHARED_LINK.DELETED,SHARED_LINK.CREATED,SHARED_LINK.UPDATED,SIGN_REQUEST.COMPLETED,SIGN_REQUEST.DECLINED,SIGN_REQUEST.EXPIRED,SIGN_REQUEST.SIGNER_EMAIL_BOUNCED

Webhook object

このイベントをトリガーしたWebhookオブジェクト

レスポンスの例

{
  "id": "11446498",
  "type": "webhook_event",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "source": {
    "id": "12345",
    "type": "file",
    "content_created_at": "2012-12-12T10:53:43-08:00",
    "content_modified_at": "2012-12-12T10:53:43-08:00",
    "created_at": "2012-12-12T10:53:43-08:00",
    "created_by": {
      "id": "11446498",
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "description": "Contract for Q1 renewal",
    "etag": "1",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "item_status": "active",
    "modified_at": "2012-12-12T10:53:43-08:00",
    "modified_by": {
      "id": "11446498",
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "name": "Contract.pdf",
    "owned_by": {
      "id": "11446498",
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "parent": {
      "id": "12345",
      "type": "folder",
      "etag": "1",
      "name": "Contracts",
      "sequence_id": "3"
    },
    "path_collection": {
      "entries": [
        {
          "etag": "1",
          "id": "12345",
          "type": "folder",
          "name": "Contracts",
          "sequence_id": "3"
        }
      ],
      "total_count": 1
    },
    "purged_at": "2012-12-12T10:53:43-08:00",
    "sequence_id": "3",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "shared_link": {
      "access": "open",
      "download_count": 3,
      "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
      "effective_access": "company",
      "effective_permission": "can_download",
      "is_password_enabled": true,
      "permissions": {
        "can_download": true,
        "can_edit": false,
        "can_preview": true
      },
      "preview_count": 3,
      "unshared_at": "2018-04-13T13:53:23-07:00",
      "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
      "vanity_name": "my_url",
      "vanity_url": "https://acme.app.box.com/v/my_url/"
    },
    "size": 629644,
    "trashed_at": "2012-12-12T10:53:43-08:00"
  },
  "trigger": "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"
    ]
  }
}