Envoyer des documents vers des destinations configurées (webhooks, email)
Envoyer des documents vers des destinations configurées (webhooks, e‑mail)
Guide complet pour configurer, tester et suivre l’envoi de vos documents vers des services externes
Envoyez vos documents en toute confiance : configuration des destinations, authentification, templates de payload, retries et suivi détaillé.
Ce que vous apprendrez
Choisir une destination
Sélectionnez une destination existante (webhook ou e‑mail) ou créez‑en une nouvelle pour recevoir vos documents.
Authentification & en‑têtes
Gérez Basic, Bearer/OAuth2, API key, en‑têtes personnalisés et signature HMAC pour sécuriser les envois.
Templates de payload
Utilisez des templates pour façonner le contenu envoyé (JSON ou texte), avec tokens pour insérer les champs du document.
Logique de retry
Comprenez retries, timeout et backoff (attente entre tentatives) et comment ils affectent vos envois.
Tests & suivi
Testez une destination, téléchargez la requête de test et consultez les détails de réponse / échecs.
Envoi par e‑mail
Envoyez le contenu à une ou plusieurs adresses e‑mail avec template HTML, sujet et expéditeur configurables.
Pour qui
Ce guide s’adresse aux utilisateurs non techniques qui souhaitent configurer des destinations et s’assurer que les documents générés sont livrés correctement.
:::
Introduction
Ce guide explique, pas à pas, comment configurer des destinations externes (webhooks HTTP et e‑mail), tester les envois, déclencher un envoi manuel et comprendre la logique de retry et de suivi des envois (succès / erreur). Vous y trouverez des bonnes pratiques, des mises en garde courantes et des réponses aux questions fréquentes.
Workflow : Configurer une destination (webhook ou e‑mail)
1. Ouvrir la page des destinations
Accédez à la section “Destinations” du projet où vous souhaitez publier les documents.
2. Créer une nouvelle destination
Cliquez sur “Nouvelle destination” (ou “Add destination”). Choisissez le type : Webhook (HTTP) ou E‑mail.
3. Renseigner les informations de base
Pour un webhook : saisissez l’URL destinataire, la méthode HTTP (POST, GET, etc.), et l’option “Active” pour activer l’envoi.
Pour un e‑mail : indiquez les adresses destinataires séparées par des virgules, le sujet par défaut et l’expéditeur optionnel.
4. Authentification
Choisissez le type d’authentification : Aucun, Basic, Bearer/OAuth2, ou API key.
- Basic : fournissez nom d’utilisateur et mot de passe (le système générera l’en‑tête Authorization).
- Bearer/OAuth2 : collez le token d’accès si requis.
- API key : choisissez emplacement (en‑tête ou querystring), nom et valeur.
5. En‑têtes et paramètres
Ajoutez des en‑têtes HTTP personnalisés si nécessaire (ex : X‑Company: myapp). Pour les webhooks, vous pouvez aussi ajouter des paramètres de requête supplémentaires.
6. Signature / HMAC (optionnel)
Si le destinataire demande une signature, indiquez le secret et le nom de l’en‑tête de signature. Le système calculera un HMAC du payload avec l’algorithme sélectionné et l’ajoutera à la requête.
7. Template de payload
Définissez un template de payload : soit une structure JSON avec tokens (ex. {{ title }} ou {{ generated_content }}), soit une chaîne libre. Assurez‑vous que le template aboutit à un JSON valide si vous envoyez du JSON.
8. Timeout, retries et backoff
Configurez le timeout (secondes), le nombre de retries et la stratégie de backoff (attente entre tentatives). Ces réglages contrôlent la durabilité des tentatives d’envoi.
9. Sauvegarder et tester
Enregistrez la destination. Utilisez le bouton “Tester” pour envoyer un document de test et vérifier la requête/réponse.
10. (Optionnel) Dupliquer pour template
Si vous avez une configuration réutilisable, enregistrez‑la comme modèle et dupliquez‑la pour chaque projet en adaptant seulement les paramètres nécessaires.
Bonnes pratiques de nommage
Donnez un nom explicite à chaque destination (ex. “Webhook – CI/CD Release Notes” ou “Email – Notifications Produit”) pour retrouver facilement la cible depuis l’interface d’envoi.
Workflow : Tester une destination (recommandé avant l’usage)
1. Ouvrir la destination et cliquer sur 'Tester'
Lancer le test depuis la fiche de la destination génère une requête de test et affiche le résultat.
2. Inspecter la requête générée
Téléchargez ou affichez la requête de test (URL, headers, body). Vérifiez que l’URL, les en‑têtes d’authentification et le body sont conformes aux attentes du destinataire.
3. Vérifier la réponse
Contrôlez le code HTTP et le corps de la réponse. Un code 2xx indique généralement le succès. Notez le texte ou le JSON renvoyé pour diagnostics.
4. Ajuster la configuration si nécessaire
Corrigez les en‑têtes, le token, le payload_template ou la signature en fonction des erreurs observées et retestez.
5. Enregistrer et réactiver
Quand le test est concluant, assurez‑vous que la destination est active et prête à recevoir de vrais documents.
Tester avec des exemples réels
Lors du test, utilisez un contenu représentatif (même taille et structure) pour détecter les problèmes liés à la sérialisation JSON ou aux limites de taille.
Workflow : Envoyer un document manuellement depuis la vue Document
1. Ouvrir le document à envoyer
Depuis la liste des documents, ouvrez le document que vous souhaitez envoyer.
2. Cliquer sur 'Envoyer' ou 'Send'
Dans le panneau d’actions, choisissez “Envoyer”, puis sélectionnez la destination souhaitée dans la liste déroulante.
3. Confirmer les options d’envoi
Vérifiez les options (destinataires e‑mail supplémentaires, override du sujet, ou variante du template), puis confirmez.
4. Lancer l’envoi et attendre le résultat
Le système déclenche l’envoi. Un message de succès s’affiche si la livraison a été acceptée ou un message d’erreur en cas d’échec immédiat.
5. Consulter le log de l’envoi
Accédez au suivi/diagnostic de l’envoi pour voir le code HTTP, la réponse et les tentatives. Si nécessaire, ré‑envoyez manuellement après correction.
Workflow : Envoyer un document par e‑mail (depuis interface ou automatisation)
1. Choisir l’option e‑mail comme destination
Sélectionnez la destination de type e‑mail ou entrez les adresses manuellement si l’interface le permet.
2. Personnaliser l’objet et l’expéditeur
Saisissez un sujet explicite. Si vous avez un alias d’expéditeur configuré (inbound alias), vous pouvez l’utiliser pour le from.
3. Prévisualiser l’e‑mail HTML
Vérifiez le rendu HTML si un modèle HTML est utilisé. Assurez‑vous que les images et liens sont valides et accessibles.
4. Envoyer et vérifier la boîte de réception
Validez l’envoi et inspectez la boîte de réception (ou les journaux SMTP) pour confirmer la réception. Si l’e‑mail n’arrive pas, contrôlez le relais SMTP et les en‑têtes.
5. Gérer les erreurs (rebonds)
En cas de rebond, consultez le log pour l’erreur SMTP : adresse invalide, quota atteint, ou blocage par le fournisseur. Corrigez et renvoyez.
Erreur fréquente — destination inactive ou projet incorrect
Si la destination est désactivée ou est rattachée à un autre projet, l’envoi sera bloqué. Vérifiez toujours que la destination est active et associée au bon projet avant d’envoyer.
Workflow : Attacher une destination à un agent / hook pour envois automatiques
1. Ouvrir la configuration de l’agent/hook
Éditez le hook qui déclenche les documents (push, schedule, etc.).
2. Sélectionner la destination
Dans la section de routage de sortie, choisissez la destination précédemment configurée.
3. Sauvegarder et activer le hook
Enregistrez la configuration et assurez‑vous que le hook est actif pour que les générations futures déclenchent l’envoi.
4. Exécuter un test (preview) du hook
Utilisez la fonction de prévisualisation pour générer un document de test et vérifier que l’envoi automatique fonctionne correctement.
5. Surveiller les livraisons automatiques
Consultez régulièrement les logs d’exécution du hook pour détecter les erreurs répétées et ajuster les paramètres (timeouts, retries).
Workflow : Comprendre la logique de retry, timeout et backoff
1. Nombre de tentatives (retries)
Le paramètre ‘retries’ définit combien de tentatives seront effectuées en cas d’échec. Exemple : retries = 3 → jusqu’à 4 tentatives au total (tentative initiale + 3 relances).
2. Timeout par tentative
Le timeout définit la durée maximale d’attente pour une réponse avant d’abandonner la tentative et passer à la suivante.
3. Stratégie de backoff
Le backoff définit l’attente entre tentatives. Une approche courante est le backoff linéaire (ex. 10s, 20s, 30s) ou exponentiel. Ajustez selon la sensibilité du destinataire.
4. Quelle erreur déclenche un retry ?
En général, les erreurs réseau, timeouts ou codes HTTP 5xx entraînent des retries. Les erreurs 4xx (mauvaise requête, auth rejetée) sont souvent considérées comme non récupérables et ne déclenchent pas de retry prolongé.
5. Logs et alertes après épuisement
Si toutes les tentatives échouent, l’événement apparaît comme échec final dans les logs. Programmez des alertes pour surveiller ces échecs critiques.
Paramètres recommandés pour la plupart des webhooks
Commencez par : timeout 30s, retries 3, backoff 10s. Ajustez en fonction de la latence et de la stabilité du service destinataire.
Quand utiliser chaque méthode d’authentification :
- Basic : services internes simples.
- Bearer/OAuth2 : services tiers avec tokens (API modernes).
- API key : si le récepteur accepte une clé dédiée.
- Aucun : uniquement pour endpoints publics et non sensibles.
Emplacements de la clé API :
- En‑tête : plus sûr, évite d’exposer la clé dans les logs d’URL.
- Querystring : simple mais peut être enregistré dans logs intermédiaires.
- Dans le corps : utile pour certains services, mais dépend du format attendu.
- Utilisez les webhooks pour livrer JSON structuré ou textes vers des services HTTP.
- Authentification : Basic, Bearer, API key (header ou query).
- Signature : HMAC pour garantir l’intégrité.
- Vérifiez que le destinataire accepte le Content‑Type envoyé (application/json ou text/plain).
- Tests : inspectez le body et les headers (token, signature).
Pièges courants à éviter
- Template JSON mal formé : vérifiez toujours que le payload final est un JSON valide après substitution des tokens.
- Authentification incorrecte : token expiré, clé mal placée ou nom d’en‑tête erroné entraînent des échecs immédiats.
- Destination attachée à un autre projet : l’envoi est bloqué pour des raisons de sécurité.
- Signature HMAC mal configurée : différence d’algorithme ou secret incorrect → rejet côté destinataire.
Frequently Asked Questions
Sécurité et rotation des secrets
Gérez soigneusement les secrets (API keys, tokens, secrets de signature). Changez‑les régulièrement et mettez à jour la configuration des destinations en cas de rotation.
Checklist avant mise en production
- Nom explicite de la destination.
- Authentification testée (Basic/Bearer/API key).
- Payload template validé avec un test représentatif.
- Timeout, retries et backoff ajustés.
- Signature configurée si nécessaire.
- Destination active et associée au bon projet.
Prêt à configurer une destination ?
Suivez les étapes ci‑dessous pour ajouter votre webhook ou configuration e‑mail et lancez un test de livraison.