Passer au contenu principal
Les hooks sont des fonctions de rappel qui exécutent votre code en réponse à des événements d’agent, comme un outil appelé, une session démarrée ou l’exécution arrêtée. Avec les hooks, vous pouvez :
  • Bloquer les opérations dangereuses avant leur exécution, comme les commandes shell destructrices ou l’accès non autorisé aux fichiers
  • Enregistrer et auditer chaque appel d’outil pour la conformité, le débogage ou l’analyse
  • Transformer les entrées et les sorties pour nettoyer les données, injecter des identifiants ou rediriger les chemins de fichiers
  • Exiger une approbation humaine pour les actions sensibles comme les écritures de base de données ou les appels API
  • Suivre le cycle de vie de la session pour gérer l’état, nettoyer les ressources ou envoyer des notifications
Ce guide couvre le fonctionnement des hooks, comment les configurer et fournit des exemples pour les modèles courants comme bloquer les outils, modifier les entrées et transférer les notifications.

Fonctionnement des hooks

1

Un événement se déclenche

Quelque chose se produit lors de l’exécution de l’agent et le SDK déclenche un événement : un outil est sur le point d’être appelé (PreToolUse), un outil a renvoyé un résultat (PostToolUse), un sous-agent a démarré ou s’est arrêté, l’agent est inactif ou l’exécution s’est terminée. Consultez la liste complète des événements.
2

Le SDK collecte les hooks enregistrés

Le SDK vérifie les hooks enregistrés pour ce type d’événement. Cela inclut les hooks de rappel que vous transmettez dans options.hooks et les hooks de commande shell à partir des fichiers de paramètres lorsque l’entrée settingSources ou setting_sources correspondante est activée, ce qui est le cas pour les options query() par défaut.
3

Les matchers filtrent les hooks qui s'exécutent

Si un hook a un motif matcher (comme "Write|Edit"), le SDK le teste par rapport à la cible de l’événement (par exemple, le nom de l’outil). Les hooks sans matcher s’exécutent pour chaque événement de ce type.
4

Les fonctions de rappel s'exécutent

Chaque fonction de rappel du hook correspondant reçoit des informations sur ce qui se passe : le nom de l’outil, ses arguments, l’ID de session et d’autres détails spécifiques à l’événement.
5

Votre rappel retourne une décision

Après avoir effectué toute opération (enregistrement, appels API, validation), votre rappel retourne un objet de sortie qui indique à l’agent quoi faire : autoriser l’opération, la bloquer, modifier l’entrée ou injecter du contexte dans la conversation.
L’exemple suivant réunit ces étapes. Il enregistre un hook PreToolUse (étape 1) avec un matcher "Write|Edit" (étape 3) afin que le rappel ne se déclenche que pour les outils d’écriture de fichiers. Lorsqu’il est déclenché, le rappel reçoit l’entrée de l’outil (étape 4), vérifie si le chemin du fichier cible un fichier .env et retourne permissionDecision: "deny" pour bloquer l’opération (étape 5) :

Hooks disponibles

Le SDK fournit des hooks pour différentes étapes de l’exécution de l’agent. Certains hooks sont disponibles dans les deux SDK, tandis que d’autres sont réservés à TypeScript.

Configurer les hooks

Pour configurer un hook, transmettez-le dans le champ hooks de vos options d’agent (ClaudeAgentOptions en Python, l’objet options en TypeScript) :
L’option hooks est un dictionnaire en Python ou un objet en TypeScript, où :

Matchers

Utilisez les matchers pour filtrer quand vos rappels se déclenchent. Le champ matcher correspond à une valeur différente selon le type d’événement hook. Par exemple, les hooks basés sur les outils correspondent au nom de l’outil, tandis que les hooks Notification correspondent au type de notification. Consultez la référence des hooks Claude Code pour la liste complète des valeurs de matcher pour chaque type d’événement. Les matchers du SDK suivent les mêmes règles que les matchers dans les fichiers de paramètres. Un matcher contenant uniquement des lettres, des chiffres, _, -, des espaces, , et | est comparé comme une chaîne exacte, avec des alternatives séparées par | ou , et des espaces blancs optionnels autour, donc Write|Edit et Write, Edit correspondent exactement à ces deux outils et code-reviewer correspond uniquement à ce type d’agent. Un matcher de *, une chaîne vide, ou l’omission du matcher entièrement correspond à chaque occurrence de l’événement. Un matcher contenant tout autre caractère est évalué comme une expression régulière non ancrée, donc ^mcp__ correspond à chaque outil MCP et Edit.* correspond à la fois à Edit et à NotebookEdit. Enveloppez une expression régulière dans ^ et $ lorsque vous avez besoin d’une correspondance de chaîne entière. Un matcher comme mcp__memory ou mcp__brave-search contient uniquement des caractères de correspondance exacte, donc il est comparé comme une chaîne exacte et ne correspond à aucun outil ; utilisez mcp__memory__.* pour correspondre à chaque outil de ce serveur. Les traits d’union dans l’ensemble de correspondance exacte nécessitent un runtime Claude Code v2.1.195 ou ultérieur. Sur les versions antérieures, un nom avec trait d’union comme code-reviewer est évalué comme une expression régulière non ancrée et doit être ancré comme ^code-reviewer$ pour correspondre exactement. Utilisez le motif matcher pour cibler des outils spécifiques chaque fois que possible. Un matcher avec 'Bash' s’exécute uniquement pour les commandes Bash, tandis que l’omission du motif exécute vos rappels pour chaque occurrence de l’événement. Pour les hooks basés sur les outils, les matchers ne filtrent que par nom d’outil, pas par chemins de fichiers ou d’autres arguments. Pour filtrer par chemin de fichier, vérifiez tool_input.file_path à l’intérieur de votre rappel.
Découvrir les noms d’outils : Consultez Types d’entrée d’outil pour la liste complète des noms d’outils intégrés, ou ajoutez un hook sans matcher pour enregistrer tous les appels d’outils que votre session effectue.Nommage des outils MCP : Les outils MCP commencent toujours par mcp__ suivi du nom du serveur et de l’action : mcp__<server>__<action>. Par exemple, si vous configurez un serveur nommé playwright, ses outils seront nommés mcp__playwright__browser_screenshot, mcp__playwright__browser_click, et ainsi de suite. Le nom du serveur provient de la clé que vous utilisez dans la configuration mcpServers.

Fonctions de rappel

Entrées

Chaque rappel hook reçoit trois arguments :
  • Données d’entrée : un objet typé contenant les détails de l’événement. Chaque type de hook a sa propre forme d’entrée. Par exemple, PreToolUseHookInput inclut tool_name et tool_input, tandis que NotificationHookInput inclut message. Consultez les définitions de type complètes dans les références du SDK TypeScript et Python.
    • Toutes les entrées de hook partagent session_id, cwd et hook_event_name.
    • agent_id et agent_type sont remplis lorsque le hook se déclenche à l’intérieur d’un sous-agent. En TypeScript, ceux-ci se trouvent sur l’entrée de hook de base et sont disponibles pour tous les types de hook. En Python, ils sont des champs optionnels sur PreToolUse, PostToolUse, PostToolUseFailure et PermissionRequest, et des champs requis sur SubagentStart et SubagentStop.
  • ID d’utilisation d’outil (str | None / string | undefined) : met en corrélation les événements PreToolUse et PostToolUse pour le même appel d’outil.
  • Contexte : en TypeScript, contient une propriété signal (AbortSignal) pour l’annulation. En Python, cet argument est réservé pour une utilisation future.

Sorties

Votre rappel retourne un objet avec deux catégories de champs :
  • Champs de niveau supérieur fonctionnent de la même manière sur chaque événement : systemMessage affiche un message à l’utilisateur, et continue (continue_ en Python) détermine si l’agent continue à s’exécuter après ce hook.
  • hookSpecificOutput contrôle l’opération actuelle. Les champs à l’intérieur dépendent du type d’événement hook. Pour les hooks PreToolUse, c’est là que vous définissez permissionDecision ("allow", "deny", "ask" ou "defer"), permissionDecisionReason et updatedInput. Retourner "defer" termine la requête pour que vous puissiez la reprendre plus tard. Pour les hooks PostToolUse, vous pouvez définir additionalContext pour ajouter des informations au résultat de l’outil. Pour remplacer la sortie de l’outil avant que Claude ne la voie, définissez updatedToolOutput, qui fonctionne pour n’importe quel outil dans les deux SDK. Le champ plus ancien updatedMCPToolOutput remplace uniquement la sortie de l’outil MCP et est déprécié.
Retournez {} pour autoriser l’opération sans modifications. Les hooks de rappel du SDK utilisent le même format de sortie JSON que les hooks de commande shell Claude Code, qui documente chaque champ et option spécifique à l’événement. Pour les définitions de type du SDK, consultez les références du SDK TypeScript et Python.
Lorsque plusieurs hooks ou règles de permission s’appliquent, deny a priorité sur defer, qui a priorité sur ask, qui a priorité sur allow. Si un hook retourne deny, l’opération est bloquée indépendamment des autres hooks.

Sortie asynchrone

Par défaut, l’agent attend que votre hook retourne avant de continuer. Si votre hook effectue un effet secondaire, tel que la journalisation ou l’envoi d’un webhook, et n’a pas besoin d’influencer le comportement de l’agent, vous pouvez retourner une sortie asynchrone à la place. Cela indique à l’agent de continuer immédiatement sans attendre la fin du hook :
Les sorties asynchrones ne peuvent pas bloquer, modifier ou injecter du contexte dans l’opération puisque l’agent a déjà avancé. Utilisez-les uniquement pour les effets secondaires comme la journalisation, les métriques ou les notifications.

Exemples

Modifier l’entrée de l’outil

Cet exemple intercepte les appels d’outil Write et réécrit l’argument file_path pour ajouter /sandbox, redirigeant toutes les écritures de fichiers vers un répertoire en sandbox. Le rappel retourne updatedInput avec le chemin modifié et permissionDecision: 'allow' pour approuver automatiquement l’opération réécrite :
Lors de l’utilisation de updatedInput, vous devez également inclure permissionDecision: 'allow' pour approuver automatiquement l’entrée modifiée ou permissionDecision: 'ask' pour la montrer à l’utilisateur. Avec 'defer', updatedInput est ignoré. Retournez toujours un nouvel objet plutôt que de muter le tool_input original.

Ajouter du contexte et bloquer un outil

Cet exemple bloque les écritures dans le répertoire /etc et explique pourquoi au modèle et à l’utilisateur :
  • permissionDecision: 'deny' arrête l’appel d’outil.
  • permissionDecisionReason indique au modèle pourquoi, afin qu’il évite de réessayer.
  • systemMessage montre à l’utilisateur ce qui s’est passé.

Approuver automatiquement des outils spécifiques

Par défaut, l’agent peut demander une permission avant d’utiliser certains outils. Cet exemple approuve automatiquement les outils de système de fichiers en lecture seule (Read, Glob, Grep) en retournant permissionDecision: 'allow', les laissant s’exécuter sans confirmation de l’utilisateur tout en laissant tous les autres outils soumis aux vérifications de permission normales :

Enregistrer plusieurs hooks

Quand un événement se déclenche, tous les hooks correspondants s’exécutent en parallèle. Pour les décisions de permission, le résultat le plus restrictif gagne : un seul deny bloque l’appel d’outil indépendamment de ce que les autres hooks retournent. Parce que l’ordre d’exécution est non-déterministe, écrivez chaque hook pour agir indépendamment plutôt que de compter sur l’exécution préalable d’un autre hook. L’exemple ci-dessous enregistre trois vérifications indépendantes pour chaque appel d’outil :

Filtrer avec des matchers multi-outils

Utilisez des matchers multi-outils pour partager un rappel entre outils connexes. Cet exemple enregistre trois matchers avec des portées différentes :
  • Une liste exacte séparée par des barres (Write|Edit|Delete) déclenche file_security_hook uniquement pour les outils de modification de fichiers.
  • Une regex (^mcp__) déclenche mcp_audit_hook pour tout outil MCP dont le nom commence par mcp__.
  • Un matcher omis déclenche global_logger pour chaque appel d’outil indépendamment du nom.

Suivre l’activité des sous-agents

Utilisez les hooks SubagentStop pour surveiller quand les sous-agents terminent leur travail. Consultez le type d’entrée complet dans les références du SDK TypeScript et Python. Cet exemple enregistre un résumé chaque fois qu’un sous-agent se termine :

Effectuer des requêtes HTTP à partir des hooks

Les hooks peuvent effectuer des opérations asynchrones comme les requêtes HTTP. Capturez les erreurs à l’intérieur de votre hook au lieu de les laisser se propager, car une exception non gérée peut interrompre l’agent. Cet exemple envoie un webhook après chaque exécution d’outil, enregistrant quel outil a été exécuté et quand. Le hook capture les erreurs afin qu’un webhook échoué n’interrompe pas l’agent :

Transférer les notifications à Slack

Utilisez les hooks Notification pour recevoir les notifications système de l’agent et les transférer vers des services externes. Les notifications se déclenchent pour des types d’événements tels que :
  • permission_prompt quand Claude a besoin d’une permission
  • idle_prompt quand Claude attend une entrée
  • auth_success quand l’authentification se termine
  • elicitation_dialog, elicitation_complete, et elicitation_response pour les flux d’élicitation d’entrée utilisateur
Chaque notification inclut un champ message avec une description lisible par l’homme et optionnellement un title. Cet exemple transfère chaque notification à un canal Slack. Il nécessite une URL de webhook entrant Slack, que vous créez en ajoutant une application à votre espace de travail Slack et en activant les webhooks entrants :

Corriger les problèmes courants

Hook ne se déclenche pas

  • Vérifiez que le nom de l’événement hook est correct et sensible à la casse (PreToolUse, pas preToolUse)
  • Vérifiez que votre motif matcher correspond exactement au nom de l’outil
  • Assurez-vous que le hook se trouve sous le type d’événement correct dans options.hooks
  • Pour les hooks non basés sur les outils qui prennent en charge les matchers, comme Notification et SubagentStop, les matchers correspondent à des champs différents, et Stop ignore complètement les matchers (consultez motifs matcher)
  • Les hooks peuvent ne pas se déclencher lorsque l’agent atteint la limite max_turns car la session se termine avant que les hooks puissent s’exécuter

Matcher ne filtre pas comme prévu

Les matchers ne correspondent qu’aux noms d’outils, pas aux chemins de fichiers ou à d’autres arguments. Pour filtrer par chemin de fichier, vérifiez tool_input.file_path à l’intérieur de votre hook :

Délai d’expiration du hook

  • Augmentez la valeur timeout dans la configuration HookMatcher
  • Utilisez le AbortSignal du troisième argument de rappel pour gérer l’annulation correctement en TypeScript
Un rappel UserPromptSubmit ou UserPromptExpansion qui dépasse son délai d’expiration bloque cette invite avec un message de délai d’expiration et la session continue. L’interruption de la requête pendant qu’un rappel est en attente annule l’appel d’outil en attente. Avant la v2.1.208, un délai d’expiration de rappel sur ces événements terminait la requête avec error_during_execution, et une interruption pendant un rappel PreToolUse en attente pouvait laisser l’appel d’outil se poursuivre.

Outil bloqué de manière inattendue

  • Vérifiez tous les hooks PreToolUse pour les retours permissionDecision: 'deny'
  • Ajoutez la journalisation à vos hooks pour voir quel permissionDecisionReason ils retournent
  • Vérifiez que les motifs matcher ne sont pas trop larges : un matcher vide correspond à tous les outils

Entrée modifiée non appliquée

  • Assurez-vous que updatedInput se trouve à l’intérieur de hookSpecificOutput, pas au niveau supérieur :
  • Retournez permissionDecision: 'allow' pour approuver automatiquement l’entrée modifiée, ou 'ask' pour la montrer à l’utilisateur pour approbation
  • Incluez hookEventName dans hookSpecificOutput pour identifier le type de hook pour lequel la sortie est destinée

Hooks de session non disponibles en Python

SessionStart et SessionEnd peuvent être enregistrés en tant que hooks de rappel du SDK en TypeScript, mais ne sont pas disponibles dans le SDK Python car son type HookEvent les omet. En Python, ils ne sont disponibles que comme hooks de commande shell définis dans les fichiers de paramètres tels que .claude/settings.json. Pour charger les hooks de commande shell à partir de votre application SDK, incluez la source de paramètre appropriée avec setting_sources ou settingSources :
Pour exécuter la logique d’initialisation en tant que rappel du SDK Python à la place, utilisez le premier message de client.receive_response() comme déclencheur.

Les invites de permission des sous-agents se multiplient

Lors du lancement de plusieurs sous-agents, chacun peut demander des permissions séparément. Les sous-agents n’héritent pas automatiquement des permissions de l’agent parent. Pour éviter les invites répétées, utilisez les hooks PreToolUse pour approuver automatiquement des outils spécifiques, ou configurez des règles de permission qui s’appliquent aux sessions de sous-agent.

Boucles de hook récursives avec des sous-agents

Un hook UserPromptSubmit qui lance des sous-agents peut créer des boucles infinies si ces sous-agents déclenchent le même hook. Pour éviter cela :
  • Vérifiez un indicateur de sous-agent dans l’entrée du hook avant de lancer
  • Utilisez une variable partagée ou un état de session pour suivre si vous êtes déjà à l’intérieur d’un sous-agent
  • Limitez les hooks pour qu’ils s’exécutent uniquement pour la session d’agent de niveau supérieur

systemMessage n’apparaît pas dans la sortie

Le champ systemMessage affiche un message à l’utilisateur, pas au modèle. Par défaut, le SDK ne fait pas apparaître la sortie du hook dans le flux de messages que pour les hooks SessionStart et Setup, donc un message provenant de tout autre événement hook n’apparaît pas à moins que vous définissiez includeHookEvents (include_hook_events en Python). Pour transmettre du contexte au modèle à la place, retournez additionalContext. Si vous avez besoin de faire apparaître les décisions de hook à votre application de manière fiable, enregistrez-les séparément ou utilisez un canal de sortie dédié.