Core
Framework v2.x
2

Plugin Events #

API Events #

Plugins can add new controllers to the Kuzzle API.

These new controllers and actions behave exactly like native API actions. All calls to plugins API actions trigger two of these three events:

  • before the action starts
  • after it succeeds
  • after it fails

before #

ArgumentsTypeDescription
request
KuzzleRequest
The normalized API request

A before event is triggered before a plugin API request starts.

Naming Template #

The before event name is built using the following template:

<plugin name>/<controller>:before<Action>

  • plugin name: the plugin's name defined in the manifest file
  • controller: API controller name
  • Action: controller action, camel cased

Example #

Plugin nameAPI controllerActionAfter event name
plugincontrolleractionplugin/controller:beforeAction

after #

ArgumentsTypeDescription
request
KuzzleRequest
The normalized API request

An after event is triggered after a plugin API request succeeds.

Naming Template #

The after event name is built using the following template:

<plugin name>/<controller>:after<Action>

  • plugin name: the plugin's name defined in the manifest file
  • controller: API controller name
  • Action: controller action, camel cased

Example #

Plugin nameAPI controllerActionAfter event name
plugincontrolleractionplugin/controller:afterAction

error #

ArgumentsTypeDescription
request
KuzzleRequest
The normalized API request

An error event is triggered after a plugin API request fails.

Naming Template #

The error event name is built using the following template:

<plugin name>/<controller>:error<Action>

  • plugin name: the plugin's name defined in the manifest file
  • controller: API controller name
  • Action: controller action, camel cased

Example #

Plugin nameAPI controllerActionAfter event name
plugincontrolleractionplugin/controller:errorAction
Edit this page on Github(opens new window)