NAME
Claude::Agent::Message::HookEvent - Hook lifecycle event
DESCRIPTION
A system message with subtype hook_started, hook_progress or hook_response. The CLI always emits them for session start hooks and, with the include_hook_events option, for every hook.
ATTRIBUTES
subtype
hook_started, hook_progress or hook_response.
hook_event_name
The event the hook ran for, for example PreToolUse.
hook_name
The hook's name as the CLI reports it.
hook_id
Identifies one hook run across its started/progress/response messages.
outcome
The hook's outcome (hook_response).
output
The hook's output (hook_response).
type, uuid, session_id, parent_tool_use_id, agent_id, raw, data, slash_commands, claude_code_version, tools, output_style, plugins, model, mcp_servers, api_key_source, skills, permission_mode, cwd, agents, state
Inherited from Claude::Agent::Message::System and Claude::Agent::Message::Base. Fields not listed here are in raw.
METHODS
new
Takes a flat list of name/value pairs. Unknown names are ignored.
AUTHOR
LNATION, <email at lnation.org>
LICENSE
This software is Copyright (c) 2026 by LNATION.
This is free software, licensed under The Artistic License 2.0 (GPL Compatible).