Event source

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

The source file or folder that triggered an event in the event stream.

The object containing classification information for the item that triggered the event. This field will not appear if the item does not have a classification set.

classification.name string

exampleTop Secret

The classification's name.

item_id string

example560284318361

The unique identifier that represents the item.

item_name string

examplereport.pdf

The name of the item.

item_type string

examplefile

The type of the item that the event represents. Can be file or folder.

Value is one of file,folder

owned_byUser (Mini) object

The user who owns this item.

parentFolder (Mini) object

The optional folder that this folder is located within.

This value may be null for some folders such as the root folder or the trash folder.

Response Example

{
  "classification": {
    "name": "Top Secret"
  },
  "item_id": "560284318361",
  "item_name": "report.pdf",
  "item_type": "file",
  "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"
  }
}