notify

These events are triggered by Kuzzle's real-time engine, every time a notification is about to be sent to subscribing clients.

Synchronously listening plugin may block some (or all) notifications by rejecting the provided promise.

EventTypeDescriptionPayload
notify:dispatchPipeA Notification is about to be sent. Can be a document, a user or a server notification.
Use the type property to determine the notification type.
An object representing the notification to send
notify:documentPipeA Document Notification is about to be sentAn object representing the notification to send
notify:serverPipeA Server Notification is about to be sentAn object representing the notification to send
notify:userPipeA User Notificaiton is about to be sentAn object representing the notification to send