Intercept dan kontrol perilaku agent dengan hooks
Intercept dan customize perilaku agent pada titik eksekusi kunci dengan hooks
Hooks adalah fungsi callback yang menjalankan kode Anda sebagai respons terhadap peristiwa agent, seperti tool yang dipanggil, sesi dimulai, atau eksekusi berhenti. Dengan hooks, Anda dapat:
- Blokir operasi berbahaya sebelum dieksekusi, seperti perintah shell yang merusak atau akses file yang tidak sah
- Log dan audit setiap pemanggilan tool untuk kepatuhan, debugging, atau analitik
- Transform input dan output untuk membersihkan data, menyuntikkan kredensial, atau mengalihkan jalur file
- Memerlukan persetujuan manusia untuk tindakan sensitif seperti penulisan database atau panggilan API
- Track lifecycle sesi untuk mengelola state, membersihkan resources, atau mengirim notifikasi
Panduan ini mencakup cara kerja hooks, cara mengonfigurasinya, dan menyediakan contoh untuk pola umum seperti memblokir tools, memodifikasi input, dan meneruskan notifikasi.
Cara kerja hooks
Sebuah event terjadi
Sesuatu terjadi selama eksekusi agent dan SDK menembakkan event: tool akan dipanggil (PreToolUse), tool mengembalikan hasil (PostToolUse), subagent dimulai atau berhenti, agent idle, atau eksekusi selesai. Lihat daftar lengkap events.
SDK mengumpulkan hooks terdaftar
SDK memeriksa hooks yang terdaftar untuk tipe event tersebut. Ini termasuk callback hooks yang Anda berikan di options.hooks dan shell command hooks dari file pengaturan ketika settingSources atau setting_sources entry yang sesuai diaktifkan, yang mana untuk opsi query() default.
Matchers memfilter hooks mana yang berjalan
Jika hook memiliki pola matcher (seperti "Write|Edit"), SDK mengujinya terhadap target event (misalnya, nama tool). Hooks tanpa matcher berjalan untuk setiap event dari tipe tersebut.
Fungsi callback dieksekusi
Setiap fungsi callback hook yang cocok menerima input tentang apa yang terjadi: nama tool, argumennya, ID sesi, dan detail spesifik event lainnya.
Callback Anda mengembalikan keputusan
Setelah melakukan operasi apa pun (logging, panggilan API, validasi), callback Anda mengembalikan output object yang memberi tahu agent apa yang harus dilakukan: izinkan operasi, blokir, modifikasi input, atau suntikkan konteks ke dalam percakapan.
Contoh berikut menyatukan langkah-langkah ini. Ini mendaftarkan hook PreToolUse (langkah 1) dengan matcher "Write|Edit" (langkah 3) sehingga callback hanya terjadi untuk tools penulisan file. Ketika dipicu, callback menerima input tool (langkah 4), memeriksa apakah jalur file menargetkan file .env, dan mengembalikan permissionDecision: "deny" untuk memblokir operasi (langkah 5):
import asyncio
from claude_agent_sdk import (
AssistantMessage,
ClaudeSDKClient,
ClaudeAgentOptions,
HookMatcher,
ResultMessage,
)
# Define a hook callback that receives tool call details
async def protect_env_files(input_data, tool_use_id, context):
# Extract the file path from the tool's input arguments
file_path = input_data["tool_input"].get("file_path", "")
file_name = file_path.split("/")[-1]
# Block the operation if targeting a .env file
if file_name == ".env":
return {
"hookSpecificOutput": {
"hookEventName": input_data["hook_event_name"],
"permissionDecision": "deny",
"permissionDecisionReason": "Cannot modify .env files",
}
}
# Return empty object to allow the operation
return {}
async def main():
options = ClaudeAgentOptions(
hooks={
# Register the hook for PreToolUse events
# The matcher filters to only Write and Edit tool calls
"PreToolUse": [HookMatcher(matcher="Write|Edit", hooks=[protect_env_files])]
}
)
async with ClaudeSDKClient(options=options) as client:
await client.query("Update the database configuration")
async for message in client.receive_response():
# Filter for assistant and result messages
if isinstance(message, (AssistantMessage, ResultMessage)):
print(message)
asyncio.run(main())
import { query, HookCallback, PreToolUseHookInput } from "@anthropic-ai/claude-agent-sdk";
// Define a hook callback with the HookCallback type
const protectEnvFiles: HookCallback = async (input, toolUseID, { signal }) => {
// Cast input to the specific hook type for type safety
const preInput = input as PreToolUseHookInput;
// Cast tool_input to access its properties (typed as unknown in the SDK)
const toolInput = preInput.tool_input as Record<string, unknown>;
const filePath = toolInput?.file_path as string;
const fileName = filePath?.split("/").pop();
// Block the operation if targeting a .env file
if (fileName === ".env") {
return {
hookSpecificOutput: {
hookEventName: preInput.hook_event_name,
permissionDecision: "deny",
permissionDecisionReason: "Cannot modify .env files"
}
};
}
// Return empty object to allow the operation
return {};
};
for await (const message of query({
prompt: "Update the database configuration",
options: {
hooks: {
// Register the hook for PreToolUse events
// The matcher filters to only Write and Edit tool calls
PreToolUse: [{ matcher: "Write|Edit", hooks: [protectEnvFiles] }]
}
}
})) {
// Filter for assistant and result messages
if (message.type === "assistant" || message.type === "result") {
console.log(message);
}
}
Available hooks
SDK menyediakan hooks untuk tahap berbeda dari eksekusi agent. Beberapa hooks tersedia di kedua SDK, sementara yang lain hanya TypeScript.
| Hook Event | Python SDK | TypeScript SDK | Apa yang memicunya | Contoh use case |
|---|---|---|---|---|
PreToolUse |
Ya | Ya | Permintaan pemanggilan tool (dapat memblokir atau memodifikasi) | Blokir perintah shell berbahaya |
PostToolUse |
Ya | Ya | Hasil eksekusi tool | Log semua perubahan file ke audit trail |
PostToolUseFailure |
Ya | Ya | Kegagalan eksekusi tool | Tangani atau log kesalahan tool |
PostToolBatch |
Tidak | Ya | Batch lengkap pemanggilan tool terselesaikan, sekali per batch sebelum panggilan model berikutnya | Suntikkan konvensi sekali untuk seluruh batch |
UserPromptSubmit |
Ya | Ya | Pengajuan prompt pengguna | Suntikkan konteks tambahan ke dalam prompts |
Stop |
Ya | Ya | Penghentian eksekusi agent | Simpan state sesi sebelum keluar |
SubagentStart |
Ya | Ya | Inisialisasi subagent | Track spawning tugas paralel |
SubagentStop |
Ya | Ya | Penyelesaian subagent | Agregasi hasil dari tugas paralel |
PreCompact |
Ya | Ya | Permintaan compaction percakapan | Arsipkan transcript lengkap sebelum merangkum |
PermissionRequest |
Ya | Ya | Dialog permission akan ditampilkan | Custom permission handling |
SessionStart |
Tidak | Ya | Inisialisasi sesi | Inisialisasi logging dan telemetry |
SessionEnd |
Tidak | Ya | Penghentian sesi | Bersihkan resources sementara |
Notification |
Ya | Ya | Pesan status agent | Kirim update status agent ke Slack atau PagerDuty |
Setup |
Tidak | Ya | Setup/maintenance sesi | Jalankan tugas inisialisasi |
TeammateIdle |
Tidak | Ya | Teammate menjadi idle | Reassign pekerjaan atau notifikasi |
TaskCompleted |
Tidak | Ya | Background task selesai | Agregasi hasil dari tugas paralel |
ConfigChange |
Tidak | Ya | File konfigurasi berubah | Reload pengaturan secara dinamis |
WorktreeCreate |
Tidak | Ya | Git worktree dibuat | Track isolated workspaces |
WorktreeRemove |
Tidak | Ya | Git worktree dihapus | Bersihkan workspace resources |
Konfigurasi hooks
Untuk mengonfigurasi hook, berikan di field hooks dari opsi agent Anda (ClaudeAgentOptions di Python, object options di TypeScript):
options = ClaudeAgentOptions(
hooks={"PreToolUse": [HookMatcher(matcher="Bash", hooks=[my_callback])]}
)
async with ClaudeSDKClient(options=options) as client:
await client.query("Your prompt")
async for message in client.receive_response():
print(message)
for await (const message of query({
prompt: "Your prompt",
options: {
hooks: {
PreToolUse: [{ matcher: "Bash", hooks: [myCallback] }]
}
}
})) {
console.log(message);
}
Opsi hooks adalah dictionary (Python) atau object (TypeScript) di mana:
- Keys adalah nama hook event (misalnya,
'PreToolUse','PostToolUse','Stop') - Values adalah array dari matchers, masing-masing berisi pola filter opsional dan fungsi callback Anda
Matchers
Gunakan matchers untuk memfilter kapan callbacks Anda terjadi. Field matcher adalah string regex yang cocok dengan nilai berbeda tergantung pada tipe hook event. Misalnya, tool-based hooks cocok dengan nama tool, sementara hooks Notification cocok dengan tipe notifikasi. Lihat referensi hooks Claude Code untuk daftar lengkap nilai matcher untuk setiap tipe event.
| Option | Type | Default | Description |
|---|---|---|---|
matcher |
string |
undefined |
Pola regex yang cocok dengan field filter event. Untuk tool hooks, ini adalah nama tool. Built-in tools termasuk Bash, Read, Write, Edit, Glob, Grep, WebFetch, Agent, dan lainnya (lihat Tool Input Types untuk daftar lengkap). MCP tools menggunakan pola mcp__<server>__<action>. |
hooks |
HookCallback[] |
- | Diperlukan. Array dari fungsi callback untuk dieksekusi ketika pola cocok |
timeout |
number |
60 |
Timeout dalam detik |
Gunakan pola matcher untuk menargetkan tools spesifik kapan pun memungkinkan. Matcher dengan 'Bash' hanya berjalan untuk perintah Bash, sementara menghilangkan pola menjalankan callbacks Anda untuk setiap kemunculan event. Perhatikan bahwa untuk tool-based hooks, matchers hanya memfilter berdasarkan nama tool, bukan jalur file atau argumen lainnya. Untuk memfilter berdasarkan jalur file, periksa tool_input.file_path di dalam callback Anda.
Menemukan nama tool: Lihat Tool Input Types untuk daftar lengkap nama tool built-in, atau tambahkan hook tanpa matcher untuk log semua pemanggilan tool yang dibuat sesi Anda.
Penamaan MCP tool: MCP tools selalu dimulai dengan mcp__ diikuti oleh nama server dan action: mcp__<server>__<action>. Misalnya, jika Anda mengonfigurasi server bernama playwright, tools-nya akan dinamai mcp__playwright__browser_screenshot, mcp__playwright__browser_click, dll. Nama server berasal dari key yang Anda gunakan dalam konfigurasi mcpServers.
Callback functions
Inputs
Setiap hook callback menerima tiga argumen:
- Input data: object yang diketik berisi detail event. Setiap tipe hook memiliki bentuk input sendiri (misalnya,
PreToolUseHookInputmencakuptool_namedantool_input, sementaraNotificationHookInputmencakupmessage). Lihat definisi tipe lengkap di referensi SDK TypeScript dan Python.- Semua hook inputs berbagi
session_id,cwd, danhook_event_name. agent_iddanagent_typediisi ketika hook terjadi di dalam subagent. Di TypeScript, ini berada di base hook input dan tersedia untuk semua tipe hook. Di Python, ini hanya ada diPreToolUse,PostToolUse, danPostToolUseFailure.
- Semua hook inputs berbagi
- Tool use ID (
str | None/string | undefined): mengkorelasikan eventsPreToolUsedanPostToolUseuntuk pemanggilan tool yang sama. - Context: di TypeScript, berisi property
signal(AbortSignal) untuk pembatalan. Di Python, argumen ini dicadangkan untuk penggunaan di masa depan.
Outputs
Callback Anda mengembalikan object dengan dua kategori fields:
- Top-level fields bekerja sama pada setiap event:
systemMessagemenampilkan pesan kepada pengguna, dancontinue(continue_di Python) menentukan apakah agent terus berjalan setelah hook ini. hookSpecificOutputmengontrol operasi saat ini. Fields di dalamnya tergantung pada tipe hook event. Untuk hooksPreToolUse, di sinilah Anda menetapkanpermissionDecision("allow","deny","ask", atau"defer"),permissionDecisionReason, danupdatedInput. Mengembalikan"defer"mengakhiri query sehingga Anda dapat melanjutkannya nanti. Untuk hooksPostToolUse, Anda dapat menetapkanadditionalContextuntuk menambahkan informasi ke hasil tool, atauupdatedToolOutputuntuk mengganti output tool sepenuhnya sebelum Claude melihatnya.
Kembalikan {} untuk mengizinkan operasi tanpa perubahan. SDK callback hooks menggunakan format output JSON yang sama dengan Claude Code shell command hooks, yang mendokumentasikan setiap field dan opsi spesifik event. Untuk definisi tipe SDK, lihat referensi SDK TypeScript dan Python.
Ketika multiple hooks atau permission rules berlaku, deny mengambil prioritas atas defer, yang mengambil prioritas atas ask, yang mengambil prioritas atas allow. Jika hook apa pun mengembalikan deny, operasi diblokir terlepas dari hooks lainnya.
Asynchronous output
Secara default, agent menunggu hook Anda kembali sebelum melanjutkan. Jika hook Anda melakukan side effect (logging, mengirim webhook) dan tidak perlu mempengaruhi perilaku agent, Anda dapat mengembalikan async output sebagai gantinya. Ini memberi tahu agent untuk melanjutkan segera tanpa menunggu hook selesai:
async def async_hook(input_data, tool_use_id, context):
# Start a background task, then return immediately
asyncio.create_task(send_to_logging_service(input_data))
return {"async_": True, "asyncTimeout": 30000}
const asyncHook: HookCallback = async (input, toolUseID, { signal }) => {
// Start a background task, then return immediately
sendToLoggingService(input).catch(console.error);
return { async: true, asyncTimeout: 30000 };
};
| Field | Type | Description |
|---|---|---|
async |
true |
Sinyal mode async. Agent melanjutkan tanpa menunggu. Di Python, gunakan async_ untuk menghindari reserved keyword. |
asyncTimeout |
number |
Optional timeout dalam milliseconds untuk operasi background |
Async outputs tidak dapat memblokir, memodifikasi, atau menyuntikkan konteks ke dalam operasi karena agent telah melanjutkan. Gunakan hanya untuk side effects seperti logging, metrics, atau notifikasi.
Contoh
Modifikasi input tool
Contoh ini mengintersepsi pemanggilan tool Write dan menulis ulang argumen file_path untuk menambahkan /sandbox, mengalihkan semua penulisan file ke direktori sandboxed. Callback mengembalikan updatedInput dengan jalur yang dimodifikasi dan permissionDecision: 'allow' untuk auto-approve operasi yang ditulis ulang:
async def redirect_to_sandbox(input_data, tool_use_id, context):
if input_data["hook_event_name"] != "PreToolUse":
return {}
if input_data["tool_name"] == "Write":
original_path = input_data["tool_input"].get("file_path", "")
return {
"hookSpecificOutput": {
"hookEventName": input_data["hook_event_name"],
"permissionDecision": "allow",
"updatedInput": {
**input_data["tool_input"],
"file_path": f"/sandbox{original_path}",
},
}
}
return {}
const redirectToSandbox: HookCallback = async (input, toolUseID, { signal }) => {
if (input.hook_event_name !== "PreToolUse") return {};
const preInput = input as PreToolUseHookInput;
const toolInput = preInput.tool_input as Record<string, unknown>;
if (preInput.tool_name === "Write") {
const originalPath = toolInput.file_path as string;
return {
hookSpecificOutput: {
hookEventName: preInput.hook_event_name,
permissionDecision: "allow",
updatedInput: {
...toolInput,
file_path: `/sandbox${originalPath}`
}
}
};
}
return {};
};
Ketika menggunakan updatedInput, Anda juga harus menyertakan permissionDecision: 'allow' untuk auto-approve input yang dimodifikasi atau permissionDecision: 'ask' untuk menampilkannya kepada pengguna. Dengan 'defer', updatedInput diabaikan. Selalu kembalikan object baru daripada mutating tool_input asli.
Tambahkan konteks dan blokir tool
Contoh ini memblokir penulisan ke direktori /etc dan menjelaskan alasannya kepada model dan pengguna:
permissionDecision: 'deny'menghentikan pemanggilan tool.permissionDecisionReasonmemberitahu model mengapa, sehingga menghindari percobaan ulang.systemMessagemenunjukkan kepada pengguna apa yang terjadi.
async def block_etc_writes(input_data, tool_use_id, context):
file_path = input_data["tool_input"].get("file_path", "")
if file_path.startswith("/etc"):
return {
# Top-level field: message shown to the user
"systemMessage": "Remember: system directories like /etc are protected.",
# hookSpecificOutput: block the operation
"hookSpecificOutput": {
"hookEventName": input_data["hook_event_name"],
"permissionDecision": "deny",
"permissionDecisionReason": "Writing to /etc is not allowed",
},
}
return {}
const blockEtcWrites: HookCallback = async (input, toolUseID, { signal }) => {
const preInput = input as PreToolUseHookInput;
const toolInput = preInput.tool_input as Record<string, unknown>;
const filePath = toolInput?.file_path as string;
if (filePath?.startsWith("/etc")) {
return {
// Top-level field: message shown to the user
systemMessage: "Remember: system directories like /etc are protected.",
// hookSpecificOutput: block the operation
hookSpecificOutput: {
hookEventName: preInput.hook_event_name,
permissionDecision: "deny",
permissionDecisionReason: "Writing to /etc is not allowed"
}
};
}
return {};
};
Auto-approve tools spesifik
Secara default, agent dapat meminta permission sebelum menggunakan tools tertentu. Contoh ini auto-approves read-only filesystem tools (Read, Glob, Grep) dengan mengembalikan permissionDecision: 'allow', membiarkan mereka berjalan tanpa konfirmasi pengguna sambil meninggalkan semua tools lainnya tunduk pada pemeriksaan permission normal:
async def auto_approve_read_only(input_data, tool_use_id, context):
if input_data["hook_event_name"] != "PreToolUse":
return {}
read_only_tools = ["Read", "Glob", "Grep"]
if input_data["tool_name"] in read_only_tools:
return {
"hookSpecificOutput": {
"hookEventName": input_data["hook_event_name"],
"permissionDecision": "allow",
"permissionDecisionReason": "Read-only tool auto-approved",
}
}
return {}
const autoApproveReadOnly: HookCallback = async (input, toolUseID, { signal }) => {
if (input.hook_event_name !== "PreToolUse") return {};
const preInput = input as PreToolUseHookInput;
const readOnlyTools = ["Read", "Glob", "Grep"];
if (readOnlyTools.includes(preInput.tool_name)) {
return {
hookSpecificOutput: {
hookEventName: preInput.hook_event_name,
permissionDecision: "allow",
permissionDecisionReason: "Read-only tool auto-approved"
}
};
}
return {};
};
Daftarkan multiple hooks
Ketika event terjadi, semua hooks yang cocok berjalan secara paralel. Untuk keputusan permission, hasil yang paling ketat menang: satu deny memblokir pemanggilan tool terlepas dari apa yang dikembalikan hooks lainnya. Karena urutan penyelesaian tidak dapat diprediksi, tulis setiap hook untuk bertindak secara independen daripada mengandalkan hook lain yang telah berjalan terlebih dahulu.
Contoh di bawah ini mendaftarkan tiga pemeriksaan independen untuk setiap pemanggilan tool:
options = ClaudeAgentOptions(
hooks={
"PreToolUse": [
HookMatcher(hooks=[authorization_check]),
HookMatcher(hooks=[input_validator]),
HookMatcher(hooks=[audit_logger]),
]
}
)
const options = {
hooks: {
PreToolUse: [
{ hooks: [authorizationCheck] },
{ hooks: [inputValidator] },
{ hooks: [auditLogger] }
]
}
};
Filter dengan regex matchers
Gunakan pola regex untuk mencocokkan multiple tools. Contoh ini mendaftarkan tiga matchers dengan scope berbeda: yang pertama memicu file_security_hook hanya untuk file modification tools, yang kedua memicu mcp_audit_hook untuk tool MCP apa pun (tools yang namanya dimulai dengan mcp__), dan yang ketiga memicu global_logger untuk setiap pemanggilan tool terlepas dari nama:
options = ClaudeAgentOptions(
hooks={
"PreToolUse": [
# Match file modification tools
HookMatcher(matcher="Write|Edit|Delete", hooks=[file_security_hook]),
# Match all MCP tools
HookMatcher(matcher="^mcp__", hooks=[mcp_audit_hook]),
# Match everything (no matcher)
HookMatcher(hooks=[global_logger]),
]
}
)
const options = {
hooks: {
PreToolUse: [
// Match file modification tools
{ matcher: "Write|Edit|Delete", hooks: [fileSecurityHook] },
// Match all MCP tools
{ matcher: "^mcp__", hooks: [mcpAuditHook] },
// Match everything (no matcher)
{ hooks: [globalLogger] }
]
}
};
Lacak aktivitas subagent
Gunakan hooks SubagentStop untuk memantau ketika subagents menyelesaikan pekerjaan mereka. Lihat tipe input lengkap di referensi SDK TypeScript dan Python. Contoh ini mencatat ringkasan setiap kali subagent selesai:
async def subagent_tracker(input_data, tool_use_id, context):
# Log subagent details when it finishes
print(f"[SUBAGENT] Completed: {input_data['agent_id']}")
print(f" Transcript: {input_data['agent_transcript_path']}")
print(f" Tool use ID: {tool_use_id}")
print(f" Stop hook active: {input_data.get('stop_hook_active')}")
return {}
options = ClaudeAgentOptions(
hooks={"SubagentStop": [HookMatcher(hooks=[subagent_tracker])]}
)
import { HookCallback, SubagentStopHookInput } from "@anthropic-ai/claude-agent-sdk";
const subagentTracker: HookCallback = async (input, toolUseID, { signal }) => {
// Cast to SubagentStopHookInput to access subagent-specific fields
const subInput = input as SubagentStopHookInput;
// Log subagent details when it finishes
console.log(`[SUBAGENT] Completed: ${subInput.agent_id}`);
console.log(` Transcript: ${subInput.agent_transcript_path}`);
console.log(` Tool use ID: ${toolUseID}`);
console.log(` Stop hook active: ${subInput.stop_hook_active}`);
return {};
};
const options = {
hooks: {
SubagentStop: [{ hooks: [subagentTracker] }]
}
};
Buat HTTP requests dari hooks
Hooks dapat melakukan operasi asynchronous seperti HTTP requests. Tangkap errors di dalam hook Anda daripada membiarkan mereka menyebar, karena exception yang tidak ditangani dapat mengganggu agent.
Contoh ini mengirim webhook setelah setiap tool selesai, mencatat tool mana yang berjalan dan kapan. Hook menangkap errors sehingga webhook yang gagal tidak mengganggu agent:
import asyncio
import json
import urllib.request
from datetime import datetime
def _send_webhook(tool_name):
"""Synchronous helper that POSTs tool usage data to an external webhook."""
data = json.dumps(
{
"tool": tool_name,
"timestamp": datetime.now().isoformat(),
}
).encode()
req = urllib.request.Request(
"https://api.example.com/webhook",
data=data,
headers={"Content-Type": "application/json"},
method="POST",
)
urllib.request.urlopen(req)
async def webhook_notifier(input_data, tool_use_id, context):
# Only fire after a tool completes (PostToolUse), not before
if input_data["hook_event_name"] != "PostToolUse":
return {}
try:
# Run the blocking HTTP call in a thread to avoid blocking the event loop
await asyncio.to_thread(_send_webhook, input_data["tool_name"])
except Exception as e:
# Log the error but don't raise. A failed webhook shouldn't stop the agent
print(f"Webhook request failed: {e}")
return {}
import { query, HookCallback, PostToolUseHookInput } from "@anthropic-ai/claude-agent-sdk";
const webhookNotifier: HookCallback = async (input, toolUseID, { signal }) => {
// Only fire after a tool completes (PostToolUse), not before
if (input.hook_event_name !== "PostToolUse") return {};
try {
await fetch("https://api.example.com/webhook", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
tool: (input as PostToolUseHookInput).tool_name,
timestamp: new Date().toISOString()
}),
// Pass signal so the request cancels if the hook times out
signal
});
} catch (error) {
// Handle cancellation separately from other errors
if (error instanceof Error && error.name === "AbortError") {
console.log("Webhook request cancelled");
}
// Don't re-throw. A failed webhook shouldn't stop the agent
}
return {};
};
// Register as a PostToolUse hook
for await (const message of query({
prompt: "Refactor the auth module",
options: {
hooks: {
PostToolUse: [{ hooks: [webhookNotifier] }]
}
}
})) {
console.log(message);
}
Teruskan notifikasi ke Slack
Gunakan hooks Notification untuk menerima notifikasi sistem dari agent dan meneruskannya ke layanan eksternal. Notifikasi terjadi untuk tipe event spesifik: permission_prompt (Claude memerlukan permission), idle_prompt (Claude menunggu input), auth_success (authentication selesai), elicitation_dialog (Claude meminta pengguna), elicitation_response (pengguna menjawab elicitation), dan elicitation_complete (elicitation ditutup). Setiap notifikasi mencakup field message dengan deskripsi yang dapat dibaca manusia dan secara opsional title.
Contoh ini meneruskan setiap notifikasi ke channel Slack. Ini memerlukan Slack incoming webhook URL, yang Anda buat dengan menambahkan app ke workspace Slack Anda dan mengaktifkan incoming webhooks:
import asyncio
import json
import urllib.request
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, HookMatcher
def _send_slack_notification(message):
"""Synchronous helper that sends a message to Slack via incoming webhook."""
data = json.dumps({"text": f"Agent status: {message}"}).encode()
req = urllib.request.Request(
"https://hooks.slack.com/services/YOUR/WEBHOOK/URL",
data=data,
headers={"Content-Type": "application/json"},
method="POST",
)
urllib.request.urlopen(req)
async def notification_handler(input_data, tool_use_id, context):
try:
# Run the blocking HTTP call in a thread to avoid blocking the event loop
await asyncio.to_thread(_send_slack_notification, input_data.get("message", ""))
except Exception as e:
print(f"Failed to send notification: {e}")
# Return empty object. Notification hooks don't modify agent behavior
return {}
async def main():
options = ClaudeAgentOptions(
hooks={
# Register the hook for Notification events (no matcher needed)
"Notification": [HookMatcher(hooks=[notification_handler])],
},
)
async with ClaudeSDKClient(options=options) as client:
await client.query("Analyze this codebase")
async for message in client.receive_response():
print(message)
asyncio.run(main())
import { query, HookCallback, NotificationHookInput } from "@anthropic-ai/claude-agent-sdk";
// Define a hook callback that sends notifications to Slack
const notificationHandler: HookCallback = async (input, toolUseID, { signal }) => {
// Cast to NotificationHookInput to access the message field
const notification = input as NotificationHookInput;
try {
// POST the notification message to a Slack incoming webhook
await fetch("https://hooks.slack.com/services/YOUR/WEBHOOK/URL", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
text: `Agent status: ${notification.message}`
}),
// Pass signal so the request cancels if the hook times out
signal
});
} catch (error) {
if (error instanceof Error && error.name === "AbortError") {
console.log("Notification cancelled");
} else {
console.error("Failed to send notification:", error);
}
}
// Return empty object. Notification hooks don't modify agent behavior
return {};
};
// Register the hook for Notification events (no matcher needed)
for await (const message of query({
prompt: "Analyze this codebase",
options: {
hooks: {
Notification: [{ hooks: [notificationHandler] }]
}
}
})) {
console.log(message);
}
Perbaiki masalah umum
Hook not firing
- Verifikasi nama hook event benar dan case-sensitive (
PreToolUse, bukanpreToolUse) - Periksa bahwa pola matcher Anda cocok dengan nama tool dengan tepat
- Pastikan hook berada di bawah tipe event yang benar di
options.hooks - Untuk non-tool hooks seperti
StopdanSubagentStop, matchers cocok dengan fields berbeda (lihat matcher patterns) - Hooks mungkin tidak terjadi ketika agent mencapai batas
max_turnskarena sesi berakhir sebelum hooks dapat dieksekusi
Matcher not filtering as expected
Matchers hanya cocok dengan nama tool, bukan jalur file atau argumen lainnya. Untuk memfilter berdasarkan jalur file, periksa tool_input.file_path di dalam hook Anda:
const myHook: HookCallback = async (input, toolUseID, { signal }) => {
const preInput = input as PreToolUseHookInput;
const toolInput = preInput.tool_input as Record<string, unknown>;
const filePath = toolInput?.file_path as string;
if (!filePath?.endsWith(".md")) return {}; // Skip non-markdown files
// Process markdown files...
return {};
};
Hook timeout
- Tingkatkan nilai
timeoutdalam konfigurasiHookMatcher - Gunakan
AbortSignaldari argumen callback ketiga untuk menangani pembatalan dengan baik di TypeScript
Tool blocked unexpectedly
- Periksa semua hooks
PreToolUseuntuk returnspermissionDecision: 'deny' - Tambahkan logging ke hooks Anda untuk melihat apa
permissionDecisionReasonyang mereka kembalikan - Verifikasi pola matcher tidak terlalu luas (matcher kosong cocok dengan semua tools)
Modified input not applied
-
Pastikan
updatedInputberada di dalamhookSpecificOutput, bukan di top level:return { hookSpecificOutput: { hookEventName: "PreToolUse", permissionDecision: "allow", updatedInput: { command: "new command" } } }; -
Anda juga harus mengembalikan
permissionDecision: 'allow'atau'ask'agar modifikasi input berlaku -
Sertakan
hookEventNamedihookSpecificOutputuntuk mengidentifikasi tipe hook mana output-nya
Session hooks not available in Python
SessionStart dan SessionEnd dapat didaftarkan sebagai SDK callback hooks di TypeScript, tetapi tidak tersedia di Python SDK (HookEvent menghilangkannya). Di Python, mereka hanya tersedia sebagai shell command hooks yang didefinisikan dalam file pengaturan (misalnya, .claude/settings.json). Untuk memuat shell command hooks dari aplikasi SDK Anda, sertakan setting source yang sesuai dengan setting_sources atau settingSources:
options = ClaudeAgentOptions(
setting_sources=["project"], # Loads .claude/settings.json including hooks
)
const options = {
settingSources: ["project"] // Loads .claude/settings.json including hooks
};
Untuk menjalankan logika inisialisasi sebagai callback Python SDK sebagai gantinya, gunakan pesan pertama dari client.receive_response() sebagai trigger Anda.
Subagent permission prompts multiplying
Ketika spawning multiple subagents, masing-masing mungkin meminta permissions secara terpisah. Subagents tidak secara otomatis mewarisi parent agent permissions. Untuk menghindari prompts berulang, gunakan hooks PreToolUse untuk auto-approve tools spesifik, atau konfigurasi permission rules yang berlaku untuk sesi subagent.
Recursive hook loops with subagents
Hook UserPromptSubmit yang spawns subagents dapat membuat infinite loops jika subagents tersebut memicu hook yang sama. Untuk mencegah ini:
- Periksa indikator subagent di hook input sebelum spawning
- Gunakan shared variable atau session state untuk track apakah Anda sudah berada di dalam subagent
- Scope hooks untuk hanya berjalan untuk sesi top-level agent
systemMessage not appearing in output
Field systemMessage menampilkan pesan kepada pengguna, bukan model. Secara default SDK tidak menampilkan hook output di message stream, jadi pesan mungkin tidak muncul kecuali Anda mengatur includeHookEvents (include_hook_events di Python). Untuk meneruskan konteks ke model sebagai gantinya, kembalikan additionalContext.
Jika Anda perlu menampilkan hook decisions ke aplikasi Anda dengan andal, log mereka secara terpisah atau gunakan dedicated output channel.
Related resources
- Claude Code hooks reference: full JSON input/output schemas, event documentation, dan matcher patterns
- Claude Code hooks guide: shell command hook examples dan walkthroughs
- TypeScript SDK reference: hook types, input/output definitions, dan configuration options
- Python SDK reference: hook types, input/output definitions, dan configuration options
- Permissions: kontrol apa yang dapat dilakukan agent Anda
- Custom tools: build tools untuk extend agent capabilities