Einhängepunkte

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

• Interne Hooks (diese Seite): werden im Gateway ausgeführt, wenn Agent-Ereignisse ausgelöst werden, zum Beispiel /new, /reset, /stop oder Lebenszyklusereignisse.
• Webhooks: externe HTTP-Endpunkte, über die andere Systeme Arbeit in OpenClaw auslösen können. Siehe Webhooks.

​

Schnellstart

# List available hooks
openclaw hooks list

# Enable a hook
openclaw hooks enable session-memory

# Check hook status
openclaw hooks check

# Get detailed information
openclaw hooks info session-memory

​

Ereignistypen

​

Hooks schreiben

​

Hook-Struktur

my-hook/
├── HOOK.md          # Metadata + documentation
└── handler.ts       # Handler implementation

​

HOOK.md-Format

---
name: my-hook
description: "Short description of what this hook does"
metadata:
  { "openclaw": { "emoji": "🔗", "events": ["command:new"], "requires": { "bins": ["node"] } } }
---

# My Hook

Detailed documentation goes here.

​

Handler-Implementierung

const handler = async (event) => {
  if (event.type !== "command" || event.action !== "new") {
    return;
  }

  console.log(`[my-hook] New command triggered`);
  // Your logic here

  // Optionally send message to user
  event.messages.push("Hook executed!");
};

export default handler;

​

Wichtige Ereigniskontexte

​

Hook-Erkennung

1. Gebündelte Hooks: werden mit OpenClaw ausgeliefert
2. Plugin-Hooks: Hooks, die in installierten Plugins gebündelt sind
3. Verwaltete Hooks: ~/.openclaw/hooks/ (vom Benutzer installiert, über Workspaces hinweg gemeinsam genutzt). Zusätzliche Verzeichnisse aus hooks.internal.load.extraDirs teilen diese Priorität.
4. Workspace-Hooks: <workspace>/hooks/ (pro Agent, standardmäßig deaktiviert, bis sie ausdrücklich aktiviert werden)

​

Hook-Packs

openclaw plugins install <path-or-spec>

​

Gebündelte Hooks

openclaw hooks enable <hook-name>

​

Details zu session-memory

​

Konfiguration von bootstrap-extra-files

{
  "hooks": {
    "internal": {
      "entries": {
        "bootstrap-extra-files": {
          "enabled": true,
          "paths": ["packages/*/AGENTS.md", "packages/*/TOOLS.md"]
        }
      }
    }
  }
}

​

Details zu command-logger

​

Details zu compaction-notifier

​

Details zu boot-md

​

Plugin-Hooks

​

Konfiguration

{
  "hooks": {
    "internal": {
      "enabled": true,
      "entries": {
        "session-memory": { "enabled": true },
        "command-logger": { "enabled": false }
      }
    }
  }
}

{
  "hooks": {
    "internal": {
      "entries": {
        "my-hook": {
          "enabled": true,
          "env": { "MY_CUSTOM_VAR": "value" }
        }
      }
    }
  }
}

{
  "hooks": {
    "internal": {
      "load": {
        "extraDirs": ["/path/to/more/hooks"]
      }
    }
  }
}

​

CLI-Referenz

# List all hooks (add --eligible, --verbose, or --json)
openclaw hooks list

# Show detailed info about a hook
openclaw hooks info <hook-name>

# Show eligibility summary
openclaw hooks check

# Enable/disable
openclaw hooks enable <hook-name>
openclaw hooks disable <hook-name>

​

Bewährte Verfahren

• Halten Sie Handler schnell. Hooks werden während der Befehlsverarbeitung ausgeführt. Starten Sie aufwendige Arbeit im Fire-and-forget-Modus mit void processInBackground(event).
• Behandeln Sie Fehler sauber. Kapseln Sie riskante Operationen in try/catch; werfen Sie keine Fehler, damit andere Handler ausgeführt werden können.
• Filtern Sie Ereignisse früh. Kehren Sie sofort zurück, wenn der Ereignistyp oder die Aktion nicht relevant ist.
• Verwenden Sie spezifische Ereignisschlüssel. Bevorzugen Sie "events": ["command:new"] statt "events": ["command"], um Overhead zu reduzieren.

​

Fehlerbehebung

​

Hook nicht erkannt

# Verify directory structure
ls -la ~/.openclaw/hooks/my-hook/
# Should show: HOOK.md, handler.ts

# List all discovered hooks
openclaw hooks list

​

Hook nicht berechtigt

openclaw hooks info my-hook

​

Hook wird nicht ausgeführt

1. Prüfen Sie, ob der Hook aktiviert ist: openclaw hooks list
2. Starten Sie Ihren Gateway-Prozess neu, damit Hooks neu geladen werden.
3. Prüfen Sie die Gateway-Logs: ./scripts/clawlog.sh | grep hook

​

Verwandte Themen

• CLI-Referenz: hooks
• Webhooks
• Plugin-Hooks — prozessinterne Plugin-Lebenszyklus-Hooks
• Konfiguration