When something happens on the server, users with active clients (web browsers or mobile apps) may want to be notified immediately. Client apps may use these notifications to update the UI (e.g. a grid) or display notifications.

Considerations

Clients must be able to subscribe/unsubscribe from these events when necessary. For example navigating in admin UI can mean subscribing for the current folder and unsubscribing when navigating to a different folder.

This is an "ephemeral" feature, NOT a facebook-like permanent notification that has a history. If a client gets a notification but does not handle it, it is lost. Nothing is stored on the server side about these events.

Event types

Design an API that lets clients subscribe to various types of events:

By path

• InFolder (for example used by admin ui to update the grid)

By content type

• only users/groups
• files/folders

By event type

• created
• modified
• deleted
• etc...

Special event types

• membership changes
• permission changes
• ...?