vigiles API reference
    Preparing search index...

    Interface HookInput

    A hook event payload (the JSON Claude Code writes to the hook's stdin).

    interface HookInput {
        hook_event_name?: string;
        prompt?: string;
        source?: string;
        stop_hook_active?: boolean;
        tool_input?: unknown;
        tool_name?: string;
        tool_response?: unknown;
        readonly [k: string]: unknown;
    }

    Indexable

    • readonly [k: string]: unknown

      Any other event-specific fields.

    Index

    Properties

    hook_event_name? prompt? source? stop_hook_active? tool_input? tool_name? tool_response?

    Properties

    hook_event_name?: string

    e.g. "PreToolUse", "PostToolUse", "Stop", "SessionStart", "PreCompact".

    prompt?: string

    UserPromptSubmit.

    source?: string

    SessionStart.

    stop_hook_active?: boolean

    Stop / SubagentStop.

    tool_input?: unknown
    tool_name?: string

    PreToolUse/PostToolUse.

    tool_response?: unknown

    Settings

    Member Visibility

    On This Page

    Properties