Plugin Events

Since Kuzzle v1.0.0

Plugins can add new controllers and actions to Kuzzle's API. These new controllers and actions behave exactly like native controllers and actions. Kuzzle will automatically trigger events when requests are sent to these plugin controllers.


<pluginName>/<controller>:after<Action>

Since Kuzzle v1.0.0

Event type: Pipe

Payload: a Request object

Triggered after the action action of the controller controller added by the plugin pluginName has completed successfully.

Example: if a plugin named foo injects a controller named controller, containing an action named action, then any request successfully processed by that controller/action, triggers a foo/controller:afterAction.


<pluginName>/<controller>:before<Action>

Since Kuzzle v1.0.0

Event type: Pipe

Payload: a Request object

Triggered before the action action of the controller controller added by the plugin pluginName has started

Example: if a plugin named foo injects a controller named controller, containing an action named action, then before any request is sent to that controller/action, a foo/controller:beforeAction event is triggered.


<pluginName>/<controller>:error<Action>

Since Kuzzle v1.0.0

Event type: Pipe

Payload: a Request object

Triggered after the action action of the controller controller added by the plugin pluginName has completed with an error.

Example: if a plugin named foo injects a controller named controller, containing an action named action, then any request ending in error after being processed by that controller/action, triggers a foo/controller:afterAction.