on • AI Agent SDK

on: Decorator to register a function as a hook.

on

Method

</div>

This is a method of the HookRegistry class in the registry module.

Decorator to register a function as a hook.

python

def on(event: HookEvent, matcher: Optional[str], sequential: bool, timeout: float, priority: int) -> Callable

ParamField HookEvent

The event to hook

ParamField Optional[str]

Optional regex pattern to match targets

ParamField bool

Whether to run sequentially

ParamField float

Timeout in seconds

ParamField int

Execution order (lower runs earlier). Default 100

ResponseField Callable

Decorator function

python

@registry.on(HookEvent.BEFORE_TOOL)
    def my_hook(event_data):
        return HookResult.allow()

praisonaiagents/hooks/registry.py at line 179