Hooks API

Manage event-triggered hooks.

Endpoints

List Hooks

GET /api/v1/hooks?project_path={path}

Response:

{
  "hooks": [
    {
      "id": "abc123",
      "event": "PreToolUse",
      "matcher": "Bash",
      "type": "command",
      "command": "npm run lint",
      "scope": "user"
    }
  ]
}

Get Hooks by Event

GET /api/v1/hooks/{event}?project_path={path}

Valid events: PreToolUse, PostToolUse, PostToolUseFailure, Stop, SessionStart, SessionEnd, UserPromptSubmit, PermissionRequest, Notification, SubagentStart, SubagentStop, PreCompact

Create Hook

POST /api/v1/hooks?project_path={path}

Request Body:

{
  "event": "PreToolUse",
  "matcher": "Bash",
  "type": "command",
  "command": "npm run lint",
  "scope": "user"
}

Hook types: command, prompt, agent

Update Hook

PUT /api/v1/hooks/{hook_id}?scope={scope}&project_path={path}

Delete Hook

DELETE /api/v1/hooks/{hook_id}?scope={scope}&project_path={path}