For AI agents: the complete documentation index is at llms.txt. Remove the trailing slash from a page URL and append .md to read its Markdown version. For the docs home, use index.md.

Event

reflex_base.event.Event

An event that describes any state change in the app.

Fields

name

str

The event name.

router_data

dict[str, Any]

Default: {}

The routing data where event occurred.

payload

dict[str, Any]

Default: {}

The event payload.

Methods

from_event_type

from_event_type(
    events: Optional[IndividualEventType | list[IndividualEventType]],
    *,
    router_data: Optional[dict[str, Any]] = None,
) -> list[Event]

Create a list of Events from event-like objects.

Parameters

events

The event-like objects to create Events from.

router_data

The routing data for the events.

Returns

A list of Events created from the event-like objects.