- Bloquear operações perigosas antes de serem executadas, como comandos shell destrutivos ou acesso a arquivos não autorizado
- Registrar e auditar cada chamada de ferramenta para conformidade, depuração ou análise
- Transformar entradas e saídas para sanitizar dados, injetar credenciais ou redirecionar caminhos de arquivo
- Exigir aprovação humana para ações sensíveis como gravações em banco de dados ou chamadas de API
- Rastrear ciclo de vida da sessão para gerenciar estado, limpar recursos ou enviar notificações
Como hooks funcionam
Um evento é disparado
Algo acontece durante a execução do agente e o SDK dispara um evento: uma ferramenta está prestes a ser chamada (
PreToolUse), uma ferramenta retornou um resultado (PostToolUse), um subagente iniciou ou parou, o agente está ocioso ou a execução terminou. Veja a lista completa de eventos.O SDK coleta hooks registrados
O SDK verifica se há hooks registrados para esse tipo de evento. Isso inclui hooks de callback que você passa em
options.hooks e hooks de comando shell de arquivos de configuração quando a entrada settingSources ou setting_sources correspondente está habilitada, o que é o padrão para opções query().Matchers filtram quais hooks são executados
Se um hook tem um padrão
matcher (como "Write|Edit"), o SDK o testa contra o alvo do evento (por exemplo, o nome da ferramenta). Hooks sem um matcher são executados para cada evento desse tipo.Funções de callback são executadas
Cada função de callback do hook correspondente recebe informações sobre o que está acontecendo: o nome da ferramenta, seus argumentos, o ID da sessão e outros detalhes específicos do evento.
Seu callback retorna uma decisão
Após realizar qualquer operação (registro, chamadas de API, validação), seu callback retorna um objeto de saída que diz ao agente o que fazer: permitir a operação, bloqueá-la, modificar a entrada ou injetar contexto na conversa.
PreToolUse (etapa 1) com um matcher "Write|Edit" (etapa 3) para que o callback seja acionado apenas para ferramentas de escrita de arquivo. Quando acionado, o callback recebe a entrada da ferramenta (etapa 4), verifica se o caminho do arquivo tem como alvo um arquivo .env e retorna permissionDecision: "deny" para bloquear a operação (etapa 5):
Hooks disponíveis
O SDK fornece hooks para diferentes estágios de execução do agente. Alguns hooks estão disponíveis em ambos os SDKs, enquanto outros são apenas para TypeScript.| Evento de Hook | SDK Python | SDK TypeScript | O que o dispara | Caso de uso de exemplo |
|---|---|---|---|---|
PreToolUse | Sim | Sim | Solicitação de chamada de ferramenta (pode bloquear ou modificar) | Bloquear comandos shell perigosos |
PostToolUse | Sim | Sim | Resultado de execução de ferramenta | Registrar todas as alterações de arquivo na trilha de auditoria |
PostToolUseFailure | Sim | Sim | Falha na execução de ferramenta | Lidar ou registrar erros de ferramenta |
PostToolBatch | Não | Sim | Um lote completo de chamadas de ferramenta é resolvido, uma vez por lote antes da próxima chamada de modelo | Injetar convenções uma vez para todo o lote |
UserPromptSubmit | Sim | Sim | Envio de prompt do usuário | Injetar contexto adicional em prompts |
MessageDisplay | Não | Sim | Uma mensagem do assistente com texto é concluída, uma vez por mensagem com o texto completo da mensagem | Redigir ou reformatar o texto exibido sem alterar a transcrição |
Stop | Sim | Sim | Parada de execução do agente | Salvar estado da sessão antes de sair |
SubagentStart | Sim | Sim | Inicialização de subagente | Rastrear geração de tarefas paralelas |
SubagentStop | Sim | Sim | Conclusão de subagente | Agregar resultados de tarefas paralelas |
PreCompact | Sim | Sim | Solicitação de compactação de conversa | Arquivar transcrição completa antes de resumir |
PermissionRequest | Sim | Sim | Diálogo de permissão seria exibido | Manipulação de permissão personalizada |
SessionStart | Não | Sim | Inicialização de sessão | Inicializar registro e telemetria |
SessionEnd | Não | Sim | Encerramento de sessão | Limpar recursos temporários |
Notification | Sim | Sim | Mensagens de status do agente | Enviar atualizações de status do agente para Slack ou PagerDuty |
Setup | Não | Sim | Configuração/manutenção de sessão | Executar tarefas de inicialização |
TeammateIdle | Não | Sim | Colega fica ocioso | Reatribuir trabalho ou notificar |
TaskCompleted | Não | Sim | Tarefa em segundo plano é concluída | Agregar resultados de tarefas paralelas |
ConfigChange | Não | Sim | Arquivo de configuração muda | Recarregar configurações dinamicamente |
WorktreeCreate | Não | Sim | Git worktree criado | Rastrear espaços de trabalho isolados |
WorktreeRemove | Não | Sim | Git worktree removido | Limpar recursos de espaço de trabalho |
Configurar hooks
Para configurar um hook, passe-o no campohooks de suas opções de agente (ClaudeAgentOptions em Python, o objeto options em TypeScript):
hooks é um dicionário (Python) ou objeto (TypeScript) onde:
- Chaves são nomes de eventos de hook (por exemplo,
'PreToolUse','PostToolUse','Stop') - Valores são arrays de matchers, cada um contendo um padrão de filtro opcional e suas funções de callback
Matchers
Use matchers para filtrar quando seus callbacks são acionados. O campomatcher corresponde a um valor diferente dependendo do tipo de evento de hook. Por exemplo, hooks baseados em ferramentas correspondem ao nome da ferramenta, enquanto hooks Notification correspondem ao tipo de notificação. Veja a referência de hooks do Claude Code para a lista completa de valores de matcher para cada tipo de evento.
Os matchers do SDK seguem as mesmas regras que matchers em arquivos de configuração: um matcher contendo apenas letras, dígitos, _ e | é comparado como uma string exata, com | separando alternativas, então Write|Edit corresponde exatamente a essas duas ferramentas. Um matcher de *, uma string vazia, ou omitir o matcher inteiramente corresponde a cada ocorrência do evento; um matcher contendo qualquer outro caractere é avaliado como uma expressão regular, então ^mcp__ corresponde a cada ferramenta MCP. Um matcher como mcp__memory contém apenas letras e underscores, então é comparado como uma string exata e não corresponde a nenhuma ferramenta; use mcp__memory__.* para corresponder a cada ferramenta desse servidor.
| Opção | Tipo | Padrão | Descrição |
|---|---|---|---|
matcher | string | undefined | Padrão correspondido contra o campo de filtro do evento, seguindo as regras de comparação acima. Para hooks de ferramenta, este é o nome da ferramenta. As ferramentas integradas incluem Bash, Read, Write, Edit, Glob, Grep, WebFetch, Agent e outras (veja Tipos de Entrada de Ferramenta para a lista completa). Ferramentas MCP usam o padrão mcp__<server>__<action>. |
hooks | HookCallback[] | - | Obrigatório. Array de funções de callback a executar quando o padrão corresponde |
timeout | number | 60 | Timeout em segundos |
matcher para direcionar ferramentas específicas sempre que possível. Um matcher com 'Bash' é executado apenas para comandos Bash, enquanto omitir o padrão executa seus callbacks para cada ocorrência do evento. Observe que para hooks baseados em ferramentas, matchers filtram apenas pelo nome da ferramenta, não por caminhos de arquivo ou outros argumentos. Para filtrar por caminho de arquivo, verifique tool_input.file_path dentro de seu callback.
Funções de callback
Entradas
Cada callback de hook recebe três argumentos:- Dados de entrada: um objeto tipado contendo detalhes do evento. Cada tipo de hook tem sua própria forma de entrada (por exemplo,
PreToolUseHookInputincluitool_nameetool_input, enquantoNotificationHookInputincluimessage). Veja as definições de tipo completas nas referências do SDK TypeScript e Python.- Todas as entradas de hook compartilham
session_id,cwdehook_event_name. agent_ideagent_typesão preenchidos quando o hook é acionado dentro de um subagente. Em TypeScript, estes estão na entrada de hook base e disponíveis para todos os tipos de hook. Em Python, eles estão emPreToolUse,PostToolUseePostToolUseFailureapenas.
- Todas as entradas de hook compartilham
- ID de uso de ferramenta (
str | None/string | undefined): correlaciona eventosPreToolUseePostToolUsepara a mesma chamada de ferramenta. - Contexto: em TypeScript, contém uma propriedade
signal(AbortSignal) para cancelamento. Em Python, este argumento é reservado para uso futuro.
Saídas
Seu callback retorna um objeto com duas categorias de campos:- Campos de nível superior funcionam da mesma forma em cada evento:
systemMessagemostra uma mensagem ao usuário, econtinue(continue_em Python) determina se o agente continua executando após este hook. hookSpecificOutputcontrola a operação atual. Os campos dentro dependem do tipo de evento de hook. Para hooksPreToolUse, é aqui que você definepermissionDecision("allow","deny","ask"ou"defer"),permissionDecisionReasoneupdatedInput. Retornar"defer"encerra a consulta para que você possa retomá-la depois. Para hooksPostToolUse, você pode definiradditionalContextpara anexar informações ao resultado da ferramenta. Para substituir a saída da ferramenta antes de Claude vê-la, definaupdatedToolOutput, que funciona para qualquer ferramenta em ambos os SDKs. O campo mais antigoupdatedMCPToolOutputsubstitui apenas a saída de ferramentas MCP e está descontinuado.
{} para permitir a operação sem alterações. Hooks de callback do SDK usam o mesmo formato de saída JSON que hooks de comando shell do Claude Code, que documenta cada campo e opção específica do evento. Para as definições de tipo do SDK, veja as referências do SDK TypeScript e Python.
Quando múltiplos hooks ou regras de permissão se aplicam, deny tem prioridade sobre defer, que tem prioridade sobre ask, que tem prioridade sobre allow. Se qualquer hook retornar
deny, a operação é bloqueada independentemente de outros hooks.Saída assíncrona
Por padrão, o agente aguarda seu hook retornar antes de prosseguir. Se seu hook realiza um efeito colateral (registro, envio de webhook) e não precisa influenciar o comportamento do agente, você pode retornar uma saída assíncrona. Isso diz ao agente para continuar imediatamente sem aguardar o hook terminar:| Campo | Tipo | Descrição |
|---|---|---|
async | true | Sinaliza modo assíncrono. O agente prossegue sem aguardar. Em Python, use async_ para evitar a palavra-chave reservada. |
asyncTimeout | number | Timeout opcional em milissegundos para a operação em segundo plano |
Saídas assíncronas não podem bloquear, modificar ou injetar contexto na operação, pois o agente já avançou. Use-as apenas para efeitos colaterais como registro, métricas ou notificações.
Exemplos
Modificar entrada de ferramenta
Este exemplo intercepta chamadas de ferramenta Write e reescreve o argumentofile_path para prepender /sandbox, redirecionando todas as gravações de arquivo para um diretório em sandbox. O callback retorna updatedInput com o caminho modificado e permissionDecision: 'allow' para aprovar automaticamente a operação reescrita:
Ao usar
updatedInput, você também deve incluir permissionDecision: 'allow' para aprovar automaticamente a entrada modificada ou permissionDecision: 'ask' para mostrá-la ao usuário. Com 'defer', updatedInput é ignorado. Sempre retorne um novo objeto em vez de mutar o tool_input original.Adicionar contexto e bloquear uma ferramenta
Este exemplo bloqueia gravações no diretório/etc e explica o motivo tanto para o modelo quanto para o usuário:
permissionDecision: 'deny'interrompe a chamada de ferramenta.permissionDecisionReasoninforma ao modelo por que, para que ele evite tentar novamente.systemMessagemostra ao usuário o que aconteceu.
Aprovar automaticamente ferramentas específicas
Por padrão, o agente pode solicitar permissão antes de usar certas ferramentas. Este exemplo aprova automaticamente ferramentas de sistema de arquivos somente leitura (Read, Glob, Grep) retornandopermissionDecision: 'allow', permitindo que sejam executadas sem confirmação do usuário enquanto deixa todas as outras ferramentas sujeitas a verificações de permissão normais:
Registrar múltiplos hooks
Quando um evento é disparado, todos os hooks correspondentes são executados em paralelo. Para decisões de permissão, o resultado mais restritivo vence: um únicodeny bloqueia a chamada de ferramenta independentemente do que os outros hooks retornam. Como a ordem de conclusão é não-determinística, escreva cada hook para agir independentemente em vez de depender de outro hook ter sido executado primeiro.
O exemplo abaixo registra três verificações independentes para cada chamada de ferramenta:
Filtrar com matchers de múltiplas ferramentas
Use matchers de múltiplas ferramentas para compartilhar um callback entre ferramentas relacionadas. Este exemplo registra três matchers com escopos diferentes:- Uma lista exata separada por pipe (
Write|Edit|Delete) disparafile_security_hookapenas para ferramentas de modificação de arquivo. - Uma regex (
^mcp__) disparamcp_audit_hookpara qualquer ferramenta MCP cujo nome começa commcp__. - Um matcher omitido dispara
global_loggerpara cada chamada de ferramenta independentemente do nome.
Rastrear atividade de subagente
Use hooksSubagentStop para monitorar quando subagentes terminam seu trabalho. Veja o tipo de entrada completo nas referências do SDK TypeScript e Python. Este exemplo registra um resumo cada vez que um subagente é concluído:
Fazer requisições HTTP a partir de hooks
Hooks podem realizar operações assíncronas como requisições HTTP. Capture erros dentro de seu hook em vez de deixá-los se propagar, pois uma exceção não tratada pode interromper o agente. Este exemplo envia um webhook após cada ferramenta ser concluída, registrando qual ferramenta foi executada e quando. O hook captura erros para que um webhook falhado não interrompa o agente:Encaminhar notificações para Slack
Use hooksNotification para receber notificações do sistema do agente e encaminhá-las para serviços externos. Notificações são disparadas para tipos de evento como:
permission_promptquando Claude precisa de permissãoidle_promptquando Claude está aguardando entradaauth_successquando a autenticação é concluídaelicitation_dialog,elicitation_completeeelicitation_responsepara fluxos de elicitação de entrada do usuário
message com uma descrição legível por humanos e opcionalmente um title.
Este exemplo encaminha cada notificação para um canal Slack. Requer uma URL de webhook de entrada do Slack, que você cria adicionando um app ao seu espaço de trabalho Slack e habilitando webhooks de entrada:
Corrigir problemas comuns
Hook não é disparado
- Verifique se o nome do evento de hook está correto e sensível a maiúsculas/minúsculas (
PreToolUse, nãopreToolUse) - Verifique se seu padrão de matcher corresponde exatamente ao nome da ferramenta
- Certifique-se de que o hook está sob o tipo de evento correto em
options.hooks - Para hooks não baseados em ferramentas como
StopeSubagentStop, matchers correspondem a campos diferentes (veja padrões de matcher) - Hooks podem não ser disparados quando o agente atinge o limite
max_turnsporque a sessão termina antes que hooks possam ser executados
Matcher não filtra como esperado
Matchers apenas correspondem a nomes de ferramentas, não a caminhos de arquivo ou outros argumentos. Para filtrar por caminho de arquivo, verifiquetool_input.file_path dentro de seu hook:
Timeout de hook
- Aumente o valor
timeoutna configuraçãoHookMatcher - Use o
AbortSignaldo terceiro argumento de callback para lidar com cancelamento graciosamente em TypeScript
Ferramenta bloqueada inesperadamente
- Verifique todos os hooks
PreToolUsepara retornospermissionDecision: 'deny' - Adicione registro aos seus hooks para ver qual
permissionDecisionReasoneles estão retornando - Verifique se padrões de matcher não são muito amplos (um matcher vazio corresponde a todas as ferramentas)
Entrada modificada não aplicada
-
Certifique-se de que
updatedInputestá dentro dehookSpecificOutput, não no nível superior: -
Retorne
permissionDecision: 'allow'para aprovar automaticamente a entrada modificada, ou'ask'para mostrá-la ao usuário para aprovação -
Inclua
hookEventNameemhookSpecificOutputpara identificar qual tipo de hook a saída é
Hooks de sessão não disponíveis em Python
SessionStart e SessionEnd podem ser registrados como hooks de callback do SDK em TypeScript, mas não estão disponíveis no SDK Python (HookEvent os omite). Em Python, eles estão disponíveis apenas como hooks de comando shell definidos em arquivos de configuração (por exemplo, .claude/settings.json). Para carregar hooks de comando shell de sua aplicação SDK, inclua a fonte de configuração apropriada com setting_sources ou settingSources:
client.receive_response() como seu gatilho.
Prompts de permissão de subagente se multiplicando
Ao gerar múltiplos subagentes, cada um pode solicitar permissões separadamente. Subagentes não herdam automaticamente permissões do agente pai. Para evitar prompts repetidos, use hooksPreToolUse para aprovar automaticamente ferramentas específicas ou configure regras de permissão que se aplicam a sessões de subagente.
Loops recursivos de hook com subagentes
Um hookUserPromptSubmit que gera subagentes pode criar loops infinitos se esses subagentes acionarem o mesmo hook. Para evitar isso:
- Verifique um indicador de subagente na entrada do hook antes de gerar
- Use uma variável compartilhada ou estado de sessão para rastrear se você já está dentro de um subagente
- Escopo hooks para executar apenas para a sessão de agente de nível superior
systemMessage não aparecendo na saída
O camposystemMessage mostra uma mensagem ao usuário, não ao modelo. Por padrão, o SDK não expõe a saída de hook no fluxo de mensagens, portanto a mensagem pode não aparecer a menos que você defina includeHookEvents (include_hook_events em Python). Para passar contexto ao modelo, retorne additionalContext.
Se você precisar expor decisões de hook para sua aplicação de forma confiável, registre-as separadamente ou use um canal de saída dedicado.
Recursos relacionados
- Referência de hooks do Claude Code: esquemas JSON de entrada/saída completos, documentação de eventos e padrões de matcher
- Guia de hooks do Claude Code: exemplos de hooks de comando shell e passo a passo
- Referência do SDK TypeScript: tipos de hook, definições de entrada/saída e opções de configuração
- Referência do SDK Python: tipos de hook, definições de entrada/saída e opções de configuração
- Permissões: controlar o que seu agente pode fazer
- Ferramentas personalizadas: construir ferramentas para estender capacidades do agente