NewAutomation

  less than a minute  

View the source code

class NewAutomation

A new automation to be created.

method NewAutomation.__init__

__init__(
    name: 'str | None' = None,
    description: 'str | None' = None,
    enabled: 'bool | None' = None,
    event: 'Annotated | None' = None,
    action: 'Annotated | None' = None
) → None

Args:

  • name (Optional[str]): The name of this automation.
  • description (Optional[str]): An optional description of this automation.
  • enabled (Optional[bool]): Whether this automation is enabled. Only enabled automations will trigger.
  • event (Optional[Annotated]): The event that will trigger this automation.
  • action (Optional[Annotated]): The action that will execute when this automation is triggered.

Returns: An NewAutomation object.

property NewAutomation.scope

The scope in which the triggering event must occur.

Returns:

  • Optional[AutomationScope]: The scope property value.

Last modified September 19, 2025