🌐 Déclencheur Webhook

Le Déclencheur Webhook permet aux systèmes externes d'initier des flux de travail dans SmartFlow en envoyant des données via des requêtes API. Ce déclencheur est idéal pour intégrer SmartFlow avec des applications tierces, permettant une automatisation dynamique et fluide des tâches.

---

📝 Détails du Déclencheur

Nom : Webhook
Catégorie : Déclencheurs

---

🔧 Paramètres

1. URL Webhook

• Type : string
• Description : L'URL de point de terminaison pour le webhook afin de recevoir les requêtes entrantes. Cela est généré automatiquement pour chaque flux de travail utilisant ce déclencheur.
• Requis : Oui
• Exemple :

  https://api.smartflow.com/webhooks/{workflowId}

2. Charge Utile

• Type : object
• Description : Les données envoyées par le système externe dans le corps de la requête. Cette charge utile peut inclure des champs personnalisés en fonction de l'intégration.
• Requis : Oui
• Exemple :

  {
    "event": "order_created",
    "orderId": "12345",
    "customer": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }

3. En-têtes

• Type : object
• Description : En-têtes optionnels que le système externe pourrait inclure pour des raisons d'authentification ou de métadonnées.
• Requis : Non
• Exemple :

  {
    "Authorization": "Bearer your-api-key",
    "Content-Type": "application/json"
  }

---

🚀 Comment Ça Fonctionne

1. Configuration de l'URL Webhook :

   • Lors de la création d'un flux de travail avec un Déclencheur Webhook, SmartFlow génère une URL unique pour le webhook.
   • Partagez cette URL avec le système externe pour configurer leur intégration.

2. Récupération de la Clé API :

   • Accédez aux Paramètres du ChatModel.
   • Allez à Intégration → Web.
   • Cliquez sur Copier la Clé API pour récupérer le jeton d'authentification nécessaire.

3. Structure de la Charge Utile :

   • Les systèmes externes envoient des données (charge utile) à l'URL webhook en utilisant une requête HTTP POST.
   • La charge utile doit correspondre à la structure requise par le flux de travail.

4. Exécution du Déclencheur :

   • Lorsque le webhook reçoit une requête valide, le flux de travail associé est déclenché automatiquement.
   • SmartFlow traite la charge utile, exécute les actions définies et renvoie une réponse si nécessaire.

---

💡 Cas d'Utilisation

1. Intégration CRM :

   • Scénario : Un client crée un nouveau compte dans votre système CRM.
   • Webhook : Le CRM envoie une requête POST à SmartFlow avec les détails du client.
   • Flux de Travail : Envoie un email de bienvenue et ajoute le client à votre liste de marketing.

2. Gestion des Commandes :

   • Scénario : Une plateforme de commerce électronique traite une nouvelle commande.
   • Webhook : La plateforme envoie les détails de la commande à SmartFlow.
   • Flux de Travail : Met à jour l'inventaire, envoie un email de confirmation de commande et notifie l'entrepôt.

3. Surveillance des Incidents :

   • Scénario : Un système de surveillance détecte une erreur critique.
   • Webhook : Le système envoie une alerte à SmartFlow.
   • Flux de Travail : Crée un rapport d'incident et notifie l'équipe d'ingénierie.

---

🔍 Exemple de Configuration

Requête Webhook Entrante

URL :

https://api.smartflow.com/webhooks/abc123

Charge Utile :

{
  "event": "user_registered",
  "userId": "67890",
  "name": "Jane Doe",
  "email": "jane@example.com"
}

En-têtes :

{
  "Authorization": "Bearer 123456789",
  "Content-Type": "application/json"
}

---

🛠️ Meilleures Pratiques

1. Validation :

   • Validez les requêtes entrantes pour garantir l'intégrité des données et prévenir les abus.
   • Utilisez des en-têtes ou des jetons sécurisés pour l'authentification.

2. Sécurité de la Clé API :

   • Assurez-vous que la clé API récupérée dans Paramètres du ChatModel → Intégration → Web est conservée en sécurité et non exposée publiquement.

3. Mapping des Données :

   • Mappez clairement les champs entrants aux variables de flux de travail pour un traitement fluide.

4. Tests :

   • Testez le webhook avec des charges utiles d'exemple pour garantir la compatibilité et la fiabilité.

5. Gestion des Erreurs :

   • Configurez les flux de travail pour gérer les données manquantes ou malformées de manière élégante.

---

📊 Surveillance et Débogage

• Journaux d'Activité :
  Suivez les requêtes webhook entrantes et leur statut de traitement dans le tableau de bord de SmartFlow.

• Rapport d'Erreur :
  Identifiez les requêtes échouées et consultez les détails des erreurs pour le dépannage.

---

Cette section fournit un guide détaillé pour le Déclencheur Webhook, garantissant que les utilisateurs peuvent l'intégrer sans problème dans leurs flux de travail. Faites-moi savoir si vous avez besoin de précisions !