Get User Events

To get a user's events, authenticate as any user and make a call to the GET /events API.

curl -i -X GET "https://api.box.com/2.0/events" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

await client.events.getEvents({
  streamType: 'admin_logs' as GetEventsQueryParamsStreamTypeField,
  limit: 1,
  createdAfter: createdAfterDate,
  createdBefore: createdBeforeDate,
} satisfies GetEventsQueryParams);

client.events.get_events(
    stream_type=GetEventsStreamType.ADMIN_LOGS.value,
    limit=1,
    created_after=created_after_date,
    created_before=created_before_date,
)

await client.Events.GetEventsAsync(queryParams: new GetEventsQueryParams() { StreamType = GetEventsQueryParamsStreamTypeField.AdminLogs, Limit = 1, CreatedAfter = createdAfterDate, CreatedBefore = createdBeforeDate });

EventStream stream = new EventStream(api);
stream.addListener(new EventListener() {
  public void onEvent(BoxEvent event) {
      // Handle the event.
    }
});
stream.start();

stream_position = 0
events = client.events().get_events(stream_position=stream_position)
stream_position = events['next_stream_position']
for event in events['entries']:
    print(f'Got {event.event_type} event that occurred at {event.created_at}')

BoxEventCollection<BoxEnterpriseEvent> events = await client.EventsManager.UserEventsAsync();

client.events.get({stream_position: '1408838928446360'}, callback);

Stream Types

The user event stream support 3 types of stream.

Anonymous Users

In some cases, the event feed might list a user with an ID of 2. This is Box's internal identifier for anonymous users.

An anonymous user is a user that is not logged in. This can happen any time a user interacts with content and they aren't asked to log in first. An example would be when a user downloads a file through an open shared link.

Limitations

Box does not store events indefinitely.

User events are stored for between two weeks and two months, after which the user events are removed. Enterprise events are accessible for one year via the API and seven years via exported reports in the Box Admin Console.

The emphasis of this feed is to return the complete results quickly, which means that Box may return events more than once or out of order. Duplicate events can be identified by their event IDs.

Long Polling

The user event stream supports long-polling through the OPTIONS /events API.

Event Types

The following events can be triggered for a user. This list is not exhaustive, so it is possible events appear that are not listed.

The following events are available in all feeds.

| | COLLAB_ROLE_CHANGE | A collaborator had their role changed | | COLLAB_INVITE_COLLABORATOR | A collaborator was invited on a folder | | COLLAB_REMOVE_COLLABORATOR | A collaborator was removed from a folder | | ITEM_SYNC | A folder was marked for sync | | ITEM_UNSYNC | A folder was unmarked for sync | | ITEM_RENAME | A file or folder was renamed | | ITEM_MAKE_CURRENT_VERSION | A previous version of a file was promoted to the current version | | GROUP_ADD_USER | Added user to group | | GROUP_REMOVE_USER | Removed user from group |

The following events are only available in the all feed.

Event notifications

To reduce the noise of the event stream and optimize event consumption, the event types listed in the table trigger a limited number of notifications.