index.md

type	code	title	description	order
page	false	Core | Framework | Core	Core events list	100

Core Events

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

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

core:auth:strategyAdded

Arguments	Type	Description
strategy	object	Authentication strategy information

Triggered whenever a plugin dynamically registers an authentication strategy.

:::info 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

Arguments	Type	Description
strategy	object	Authentication strategy information

Triggered whenever a plugin dynamically removes an authentication strategy.

:::info 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

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.

:::info 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)

:::info Pipes cannot listen to that event, only hooks can. :::

core:shutdown

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

It will be removed in a future version.