Core
Framework v2.x
2

Core Events #

Kuzzle triggers many core:* events for it's internal use. Only events listed here should be used.

Use non-documented events at you own risk, we may remove them or change the payload without warning.

core:auth:strategyAdded #

Available since 1.2.0
Arguments Type Description
strategy
object
Authentication strategy information

Triggered whenever a plugin dynamically registers an authentication strategy.

Pipes cannot listen to that event, only hooks can.


strategy #

The provided strategy object has the following properties:

Properties Type Description
pluginName
string
The plugin's name defined in the manifest file
name
string
Authentication strategy name
strategy
object
Authentication strategy properties

core:auth:strategyRemoved #

Available since 1.2.0
Arguments Type Description
strategy
object
Authentication strategy information

Triggered whenever a plugin dynamically removes an authentication strategy.

Pipes cannot listen to that event, only hooks can.


strategy #

The provided strategy object has the following properties:

Properties Type Description
pluginName
string
The plugin's name defined in the manifest file
name
string
Authentication strategy name

core:kuzzleStart #

Deprecated since 2.2.0

This event is deprecated, and may be removed in a future version of Kuzzle. Use kuzzle:state:ready instead.

Triggered when Kuzzle has finished booting and is ready to process user requests.

Pipes cannot listen to that event, only hooks can.

core:overload #

Arguments Type Description
fill
number
Request buffer fill percentage

Triggered when the requests buffer fills up more quickly than requests can be processed.

The requests buffer is configurable through the limits parameters in the Kuzzle configuration.

Requests submitted while the request buffer is completely filled (i.e. the payload is equal to 100) are rejected with a ServiceUnavailableError (code 503)

Pipes cannot listen to that event, only hooks can.

core:shutdown #

Deprecated since 2.2.0

This event is deprecated and is now an alias for kuzzle:shutdown.

It will be removed in a future version.