Skip to content

Events

The Event class represents an event fired by a state inside the State machine. It encapsulates information about the events origin, payload and metadata.

  • state_id: Identifies the state that triggered this event. It is a mandatory identifier to know the event source.
  • value: Contains one or more values sent with the event. If a single string is provided, it is converted to a list, so the attribute always holds a list or None if no value was set.
  • comment: An optional human-readable comment describing details about the event.
  • occurred: A timestamp representing when the event happened, stored as an ISO 8601 string in UTC. It defaults to the current datetime in UTC if not specified.
  • state_overwrite: Optional override for the current state(s) of the state machine associated with this event.