Get Hooks

Load hooks from the workspace .openhands/hooks.json file.

This endpoint reads the hooks configuration from the project’s .openhands/hooks.json file if it exists.

Args: request: HooksRequest containing the project directory path.

Returns: HooksResponse containing the hook configuration or None.

POST /api/hooks

Get Hooks

cURL

curl --request POST \
  --url https://api.example.com/api/hooks \
  --header 'Content-Type: application/json' \
  --header 'X-Session-API-Key: <api-key>' \
  --data '
{
  "project_dir": "<string>"
}
'

200

{
  "hook_config": {
    "pre_tool_use": [
      {
        "matcher": "*",
        "hooks": [
          {
            "command": "<string>",
            "type": "command",
            "timeout": 60,
            "async": false
          }
        ]
      }
    ],
    "post_tool_use": [
      {
        "matcher": "*",
        "hooks": [
          {
            "command": "<string>",
            "type": "command",
            "timeout": 60,
            "async": false
          }
        ]
      }
    ],
    "user_prompt_submit": [
      {
        "matcher": "*",
        "hooks": [
          {
            "command": "<string>",
            "type": "command",
            "timeout": 60,
            "async": false
          }
        ]
      }
    ],
    "session_start": [
      {
        "matcher": "*",
        "hooks": [
          {
            "command": "<string>",
            "type": "command",
            "timeout": 60,
            "async": false
          }
        ]
      }
    ],
    "session_end": [
      {
        "matcher": "*",
        "hooks": [
          {
            "command": "<string>",
            "type": "command",
            "timeout": 60,
            "async": false
          }
        ]
      }
    ],
    "stop": [
      {
        "matcher": "*",
        "hooks": [
          {
            "command": "<string>",
            "type": "command",
            "timeout": 60,
            "async": false
          }
        ]
      }
    ]
  }
}

Authorizations

X-Session-API-Key · string · header · required

Body

application/json

Request body for loading hooks.

project_dir · string | null

Workspace directory path for project hooks

Response

200

application/json

Successful Response

Response containing hooks configuration.

hook_config · HookConfig · object

Hook configuration loaded from the workspace, or None if not found

Show child attributes