Créer, éditer et désactiver un AgentHook

Créer, éditer et désactiver un AgentHook

Guide pas-à-pas pour configurer des triggers d’agent — fréquence, filtres, destinations et bonnes pratiques

Apprenez à ajouter, modifier et désactiver un AgentHook depuis le DialogAgentHook : sélection de l’agent, définition de la fréquence (count + duration), application des filtres, choix des destinations et sauvegarde.

Ce que couvre cette page

Créer un AgentHook

Ajout d’un nouveau trigger pour un agent via le dialogue ; choix entre événement Git ou planification récurrente.

Éditer un AgentHook

Modification de la fréquence, des filtres d’entrée, destinations (webhook ou email) et date de prochaine exécution.

Désactiver / supprimer

Désactivation d’un hook en le supprimant ou en désactivant ses champs de fréquence ; implications sur les workers.

Fréquence flexible

Support d’une fréquence simple (count + duration) : ex. every 2 weeks, every 1 month, etc.

Filtres d’entrée

Appliquer des filtres de documents pour limiter les entrées envoyées à l’agent (agent, date, statut…).

Destinations

Choix entre envoyer la sortie vers un webhook (destination) ou envoyer par email (liste d’adresses).

Prévisualiser

Aperçu du jeu de documents sélectionné avant d’enregistrer le hook pour vérifier l’impact.

Compatibilité serveur

Affichage de l’heure serveur pour configurer correctement la prochaine exécution.

Bonnes pratiques

Conseils pour éviter les boucles, limiter le volume et sécuriser les destinations.

Pour qui ?

Ce guide s’adresse aux personnes qui gèrent l’automatisation d’un projet : responsables produit, ingénieurs non-techniques et créateurs qui souhaitent automatiser la génération ou l’envoi de contenu.

Workflow : Créer un AgentHook (nouveau hook via DialogAgentHook)

1

Étape 1 — Ouvrir le dialogue de création

Depuis la page Agents, cliquez sur le bouton pour ajouter un hook à l’agent souhaité (ou sur “Add” dans la carte de l’agent). Le DialogAgentHook s’ouvre.

2

Étape 2 — Choisir le type de hook

Sélectionnez le mode : “Git” si vous voulez déclencher sur un événement Git (push / pull_request), ou “CRON” pour une exécution planifiée.

  • Si Git : choisissez l’événement (Push ou Pull Request).
  • Si CRON : passez à l’étape suivante pour définir la fréquence.
3

Étape 3 — Définir la fréquence (si CRON)

Renseignez les deux champs :

  • Count (Every) : un nombre entier ≥ 1 (ex. 1, 2, 3).
  • Duration : unité (day / week / month / quarter / year). Exemples : Every 1 week (count=1, duration=week), Every 2 months (count=2, duration=month). Optionnel : définissez “Next Execution At” pour forcer la première exécution à une date/heure spécifique (l’heure affichée est liée à l’heure serveur).
4

Étape 4 — Charger / ajouter des documents d’entrée (facultatif)

Si vous voulez que l’agent prenne des documents en entrée, cliquez sur “Load documents as initial input” puis configurez les filtres :

  • Filtre Agent : sélectionner un agent spécifique.
  • Filtre Date : plages ou date unique.
  • Filtre Statut : draft / published. Utilisez le bouton “Preview” pour voir combien de documents correspondent aux filtres avant d’enregistrer.
5

Étape 5 — Choisir la destination de sortie

Deux modes :

  • Webhook : sélectionnez une destination existante dans la liste, ou cliquez sur “+” pour en créer une nouvelle.
  • Email : changez le mode vers Email et saisissez les adresses séparées par des virgules. Note : Si vous choisissez Webhook, la case d’email est vidée automatiquement ; inversement, la destination webhook est ignorée si vous activez Email.
6

Étape 6 — Vérifier les réglages et sauvegarder

Relisez : type (Git/CRON), fréquence, “Next Execution At”, filtres, destination/emails.

  • Utilisez la prévisualisation de documents pour valider l’impact.
  • Cliquez sur “Save”. Le hook est alors créé et sera pris en compte par le système d’exécution.
7

Étape 7 — Tester rapidement

Après sauvegarde, exécutez manuellement l’agent (si disponible) ou surveillez la première exécution planifiée. Vérifiez les logs/notifications et la destination (webhook ou email).

Tip — Toujours prévisualiser les documents

Avant d’enregistrer un hook qui utilise des documents comme entrée, utilisez “Preview” pour connaître le nombre exact de documents ciblés. Cela évite les exécutions massives inattendues.

Workflow : Éditer un AgentHook existant (modifier fréquence, filtres, destination)

1

Étape 1 — Ouvrir le hook existant

Dans la liste d’agents ou via l’aperçu des hooks, cliquez sur le hook que vous souhaitez modifier pour rouvrir le DialogAgentHook en mode édition.

2

Étape 2 — Vérifier le mode (Git vs CRON)

Confirmez si le hook est un hook Git ou CRON. Changer de mode passe certains champs à null (par exemple, la fréquence est retirée si on passe à Git).

  • Si vous basculez de Git vers CRON : remplissez frequency_count et frequency_duration.
  • Si vous basculez de CRON vers Git : sélectionnez l’événement Git et notez que la planification sera supprimée.
3

Étape 3 — Ajuster la fréquence ou la date de prochaine exécution

Modifiez Count et Duration selon vos besoins. Si vous voulez forcer une exécution précise, changez “Next Execution At” (penser à l’heure serveur affichée).

  • Laisser frequency_count/frequency_duration vides désactive la planification récurrente.
4

Étape 4 — Mettre à jour les filtres d’entrée

Ajoutez, modifiez ou supprimez les filtres de documents. Après modification, utilisez “Preview” pour vous assurer que le nouvel ensemble correspond à vos attentes.

5

Étape 5 — Changer la destination

Sélectionnez une nouvelle destination webhook, créez-en une, ou passez en mode Email et modifiez la liste d’adresses. Assurez-vous que les adresses email sont valides et que la destination webhook accepte les requêtes (authentification / signature si nécessaire).

6

Étape 6 — Sauvegarder et vérifier

Cliquez sur “Save”. Après sauvegarde, vérifiez la page des agents pour s’assurer que les informations affichées reflètent vos changements (nom / résumé). Surveillez la prochaine exécution et les logs.

Tip — Utilisez la prochaine exécution pour synchroniser

Si vous devez aligner la première exécution sur une fenêtre précise (ex. début de semaine), mettez à jour “Next Execution At” plutôt que d’attendre le calcul automatique.

Workflow : Désactiver / Supprimer un AgentHook (arrêter un trigger)

1

Étape 1 — Identifier le hook concerné

Repérez le hook dans la liste d’agents ou dans l’aperçu des hooks. Vérifiez son type et sa destination.

2

Étape 2 — Choix d’approche

Deux options :

  • Désactiver temporairement : modifier la configuration pour retirer frequency_count/frequency_duration (pour CRON) ou désactiver la destination (mettre les emails à vide). Cela empêchera les exécutions futures sans supprimer l’historique.
  • Supprimer définitivement : utilisez le bouton “Delete” dans le dialogue pour supprimer le hook.
3

Étape 3 — Supprimer / confirmer

Si vous supprimez, confirmez l’action. La suppression arrête les exécutions planifiées et retire le hook de la liste.

4

Étape 4 — Vérifier les effets

Après suppression ou modification, vérifiez que la prochaine exécution n’apparaît plus et surveillez les logs pour confirmer qu’aucune exécution planifiée n’est en cours.

5

Étape 5 — Réactivation (si besoin)

Pour réactiver, recréez le hook ou restaurez la fréquence / destination. Si vous avez supprimé, recréer un hook équivalent est la méthode standard.

Attention — conséquences d’une suppression

Supprimer un hook stoppe immédiatement toute exécution programmée. Si vous souhaitez conserver l’historique et simplement empêcher l’exécution, préférez désactiver la fréquence ou retirer la destination plutôt que de supprimer définitivement.

  • Usage idéal : automatiser traitements déclenchés par des commits ou PR (ex. création de changelogs, génération d’articles à partir de nouveaux commits).
  • Points clés :
    • Pas de fréquence à définir : l’exécution dépend des événements Git.
    • Vérifiez que le dépôt a bien un webhook externe et que l’événement choisi correspond à votre besoin.
    • Bonnes pratiques : limiter la portée (branches spécifiques) dans les filtres du dépôt si possible pour éviter exécutions sur branches non pertinentes.
  • Usage idéal : tâches récurrentes indépendantes des événements Git (résumés hebdomadaires, nettoyage mensuel, export périodique).
  • Points clés :
    • Définissez count (nombre) et duration (day/week/month/quarter/year).
    • Si vous laissez next_execution_at vide, le système calculera la prochaine exécution en fonction des champs frequency.
    • Bonnes pratiques : pour éviter pics, échelonnez des hooks lourds sur des durées longues ou utilisez un nombre plus élevé (every 2 weeks plutôt que every day).

Avant : envoyer un dump complet de tous les documents à l’agent à chaque exécution.

  • Risques : forte consommation de crédits, temps d’exécution long, sorties redondantes.

Après : appliquer des filtres ciblés (agent, date, statut) et prévisualiser.

  • Avantages : exécutions plus légères, résultats pertinents, coûts maîtrisés.

Gotcha — fuseau horaire et 'Next Execution At'

L’horodatage affiché dans le champ “Next Execution At” est aligné sur l’heure serveur. Si vous configurez la date/heure en vous fiant à l’heure locale, vérifiez l’heure serveur affichée pour éviter un décalage de plusieurs heures.

Tip — éviter les boucles d’exécution

Ne créez pas un hook qui déclenche un agent qui, en sortie, pousse à nouveau un commit ou un événement Git ciblant le même dépôt sans garde-fous. Ajoutez des filtres ou marqueurs (métadonnées) pour ignorer les documents/commits générés automatiquement.

Frequently Asked Questions

Prêt à automatiser vos workflows ?

Commencez par créer un hook de test avec filtrage restreint et une destination de test pour valider le flux avant de l’appliquer en production.

Récapitulatif rapide

  • Choisissez Git pour des déclenchements événementiels ; CRON pour des exécutions récurrentes avec count + duration.
  • Toujours prévisualiser les documents et vérifier l’heure serveur avant d’enregistrer.
  • Pour arrêter un hook, préférez désactiver ou retirer la destination pour conserver la configuration, supprimez uniquement si vous voulez retirer définitivement le trigger.