Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

hookapi

package

Go to main page

Versions in this module

v0

v0.1.1

Oct 18, 2026

v0.1.0

Oct 18, 2026

Changes in this version

+ type Action string

+ const ActionAllow

+ const ActionAsk

+ const ActionDeny

+ const ActionNoop

+ func ParseAction(s string) (Action, error)

+ type Agent string

+ const AgentClaude

+ const AgentCodex

+ const AgentCursor

+ const AgentOpenCode

+ func AllAgents() []Agent

+ func ParseAgent(s string) (Agent, error)

+ func (a Agent) Valid() bool

+ type Decision struct

+ Action Action

+ AdditionalContext string

+ Reason string

+ UpdatedInput json.RawMessage

+ UserMessage string

+ func Allow() Decision

+ func Ask(reason string) Decision

+ func Deny(reason string) Decision

+ func Noop() Decision

+ func (d Decision) Blocks() bool

+ func (d Decision) Effective() Action

+ func (d Decision) WithContext(ctx string) Decision

+ func (d Decision) WithUserMessage(msg string) Decision

+ type Event string

+ const EventPostToolUse

+ const EventPreCompact

+ const EventPreToolUse

+ const EventSessionStart

+ const EventStop

+ const EventSubagentStart

+ func AllEvents() []Event

+ func ParseEvent(s string) (Event, error)

+ func (e Event) IsToolEvent() bool

+ func (e Event) Valid() bool

+ type HookEvent struct

+ Agent Agent

+ AgentID string

+ AgentType string

+ CWD string

+ Command string

+ Event Event

+ Glob string

+ Paths []string

+ Pattern string

+ Raw json.RawMessage

+ SessionID string

+ Tool Tool

+ ToolUseID string

+ func (e HookEvent) IsSubagent() bool

+ func (e HookEvent) Validate() error

+ type Tool string

+ const ToolEdit

+ const ToolGlob

+ const ToolGrep

+ const ToolMCP

+ const ToolOther

+ const ToolPatch

+ const ToolRead

+ const ToolShell

+ const ToolWrite

+ func (t Tool) IsMutation() bool

+ func (t Tool) IsSearch() bool

+ func (t Tool) Valid() bool