Event source

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

string
560284318361

The unique identifier that represents the item.

string
report.pdf

The name of the item.

string
file

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

Value is one of file,folder

object

The user who owns this item.

11446498

The unique identifier for this user

user

Value is always user

string / email
ceo@example.com

The primary email address of this user

Aaron Levie50

The display name of this user

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.

string
12345

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folders/123 the folder_id is 123.

folder

Value is always folder

1

The HTTP etag of this folder. This can be used within some API endpoints in the If-Match and If-None-Match headers to only perform changes on the folder if (no) changes have happened.

Contracts

The name of the folder.

3

A numeric identifier that represents the most recent user event that has been applied to this item.

This can be used in combination with the GET /events-endpoint to filter out user events that would have occurred before this identifier was read.

An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the sequence_id in the event is smaller than or equal to the sequence_id in the originally fetched resource.

Response Example

{
  "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
  }
}