Box Developer Documentation
 

    Event Source

    Event Source

    If a user or item triggers an event, The response of the GET /events endpoint contains an event source object.

    User Source Object

    If a user triggers an event, the source object will be the standard representation of the user resource.

    {
      "source": {
        "id": 11446498,
        "type": "user",
        "address": "900 Jefferson Ave, Redwood City, CA 94063",
        "avatar_url": "https://www.box.com/api/avatar/large/181216415",
        "created_at": "2012-12-12T10:53:43-08:00",
        "job_title": "CEO",
        "language": "en",
        "login": "ceo@example.com",
        "max_upload_size": 2147483648,
        "modified_at": "2012-12-12T10:53:43-08:00",
        "name": "Aaron Levie",
        "notification_email": {
          "email": "notifications@example.com",
          "is_confirmed": true
        },
        "phone": 6509241374,
        "space_amount": 11345156112,
        "space_used": 1237009912,
        "status": "active",
        "timezone": "Africa/Bujumbura"
      }
    }
    

    Item Source Object

    If an item triggers an event, the source object will be the event source resource.

    The below example contains a classification object. This does not appear if the item does not have a classification set. Also, it does not appear for every event type.

    {
      "source": {
        "item_type": "file",
        "item_id": "8903212345",
        "item_name": "example.docx",
        "parent": {
          "type": "folder",
          "name": "All Files",
          "id": "0"
        },
        "owned_by": {
          "type": "user",
          "id": "11446498",
          "name": "Aaron Levie",
          "login": "notifications@example.com"
        },
        "classification": {
          "name": "Top Secret"
        }
      }
    }