notify

Since Kuzzle v1.0.0

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.


notify:dispatch

Since Kuzzle v1.0.0

Event type: Pipe

Payload: a Notification object

Triggered whenever a notification is about to be sent. This notification can be about a document, a user or a server event.
Use the type property to determine the notification type.


notify:document

Since Kuzzle v1.0.0

Event type: Pipe

Payload: a Notification object

A document notification is about to be sent.


notify:server

Since Kuzzle v1.0.0

Event type: Pipe

Payload: a Notification object

A server notification is about to be sent.


notify:user

Since Kuzzle v1.0.0

Event type: Pipe

Payload: a Notification object

A user notification is about to be sent.