Les webhooks facilitent les notifications HTTP automatisées vers des applications tierces à partir de Zoho Projects. À l'aide des webhooks, vous pouvez configurer vos propres URL HTTP et les associer à des règles métier spécifiques afin d'automatiser l'ensemble du processus de notification lié aux problèmes. Pour en savoir plus sur les webhooks, veuillez consulter la page WebHooks.org.
- Accédez à > Outil de suivi des problèmes > Webhooks.
- Cliquez sur Ajouter un webhook.
-
Sur la page Webhooks, indiquez tous les paramètres nécessaires.
-
Cliquez sur Enregistrer.
Liste des champs dans la configuration Webhook
Nom du champ
|
Description
|
Type de données
|
Contrainte
|
Nom
|
Précisez le nom du webhook.
|
Texte
|
100 caractères
|
URL à notifier
|
Spécifiez l'URL de l'API REST de l'application tierce.
|
URL
|
1000 caractères
|
Méthode
|
Sélectionnez le type de méthode API - POST ou GET. Par défaut, la méthode POST est sélectionnée.
|
Case d'option
|
-
|
Ajouter les paramètres des problèmes
|
- Ajoutez les paramètres de deux façons : soit en utilisant le format standard, soit en utilisant le format défini par l'utilisateur (xml, json, etc.).
- Précisez le nom du paramètre. Ensuite, spécifiez la valeur de paramètre correspondante choisie dans les champs de problème.
- Ces paramètres sont importants pour déclencher le webhook auprès du tiers.
|
Texte
|
3000 caractères
|
Ajouter des paramètres personnalisés
|
- Spécifiez le nom du paramètre et la valeur correspondante pour le webhook.
- Cette paire clé/valeur est principalement utilisée pour envoyer les jetons d'authentification, la clé API, etc.
|
Texte
|
3000 caractères
|
Prévisualiser l'URL
|
Prévisualisez l'URL complète du webhook à notifier à l'application tierce.
|
Lecture seule
|
Lecture seule
|
Associer un webhook à une règle métier
- Dans Règles métier, accédez à Détails de la règle -> Critère -> Actions.
- Dans Actions, cliquez sur Appeler des webhooks.
-
Cliquez sur
pour créer un nouveau webhook ou cliquez sur
pour appeler un webhook existant pour la règle métier.
- Cliquez sur Enregistrer la règle.
En savoir plus sur la configuration des règles métier.
Tester l'intégration du webhook
- Ajoutez des données de test dans Zoho Projects en fonction de vos critères de règle métier.
- Dans votre application, vérifiez la mise à jour/les données reçues de Zoho Projects via une notification de type « webhook ».
- S'il y a une erreur ou une incohérence de données, modifiez vos paramètres de webhook dans Zoho Projects.
- Continuez les tests jusqu'à ce que vous obteniez les résultats souhaités de Zoho Projects vers votre application.
Webhooks prend en charge les Paramètres liés au problème (titre du problème, statut, cessionnaire, etc.) et les Paramètres personnalisés.
Limitations connues
Codes d'erreur
Lorsque l'exécution d'un webhook échoue, l'un des messages d'erreur suivants s'affiche dans Zoho Projects :
Codes d'état HTTP
- 400 Demande incorrecte : il manque souvent un paramètre requis.
- 401 Non autorisé : aucun jeton d'authentification valide fourni.
- 402 Échec de la demande : les paramètres étaient valides, mais la demande a échoué.
- 404 Non trouvé : l'élément demandé n'existe pas.
- 500, 502, 503, 504 Erreurs de serveur : un problème est survenu dans l'application tierce.
- Code d'erreur 1 : connexion au serveur API temporairement impossible. Vous devez vérifier les journaux de serveur API, les paramètres du pare-feu pour trouver nos requêtes envoyées depuis Zoho Projects.
Erreurs personnalisées
- Échec de processus interne : lorsque le webhook n'est pas exécuté en raison d'erreurs lors du traitement du webhook.
- Limite journalière atteinte : lorsque la société atteint le seuil maximum pour la journée.
Scénario métier
Envoyer des alertes SMS aux propriétaires de projet.
Objectif
Lorsqu'un problème est marqué comme Afficher le repère dans votre outil de suivi des problèmes, vous pouvez envoyer un SMS avec le titre du problème au propriétaire du projet en associant un webhook à une règle métier.
Prérequis
- Compte dans le service de passerelle SMS
- Autorisation d'accéder aux règles métier et aux webhooks
Procédure
- Créer un compte dans le service de passerelle SMS
- Configurer le webhook dans l'outil de suivi des problèmes de Zoho
- Configurer une règle métier
- Tester l'intégration de votre webhook
Étape 1 : créer un compte dans la passerelle SMS
Dans votre service de passerelle SMS, créez un compte et trouvez les informations suivantes pour configurer le webhook :
- URL de l'API
- Nom d'utilisateur
- Mot de passe
- ID de l'API
Actuellement, Zoho a établi un partenariat avec les fournisseurs de passerelle SMS suivants :
- Bulk SMS
- Clickatell
- Screen Magic
- Valueleaf
- Solutions Infini
Vous pouvez acheter des crédits SMS et des informations sur les API aux fournisseurs ci-dessus.
Dans la page Webhooks, spécifiez les informations suivantes :
URL à notifier :
- http://<IP Address>/smsgateway/post - Méthode POST
Paramètres au format défini par l'utilisateur :
Nom du paramètre : Texte
Valeur du paramètre :
Bonjour ${Issue.ProjectOwner},
Le problème suivant est marqué comme ${Issue.Severity}.
${Issue.IssueKey} - ${Issue.IssueTitle}
Échéance le ${Issue.DueDate}
Paramètre personnalisé (Nom = Valeur) :
user = <gateway_user_name>
password = <api_password>
api_id = <gateway_unique_api_id>
to = <user_mobile_number>
Dans le paramètre personnalisé et défini par l'utilisateur ci-dessus, nous avons utilisé la passerelle Clickatell à des fins de démonstration.
Étape 3 : configurer une règle métier
Créez une règle métier avec les spécifications suivantes :
- Nom de la règle métier - Afficher le repère
- Exécuter lors de - Mise à jour du champ - Gravité
- Critères : la gravité est Afficher le repère et le statut n'est pas Fermé
-
Action :
- Reproductible - Toujours
- Attribuer à - Développeur
- Appeler le webhook - Choisir le webhook créé à l'étape précédente
- Enregistrez la règle métier. En savoir plus sur la création de règles métier.
Étape 4 : tester l'intégration
Ajoutez un problème de test dans le projet et attribuez-le à un développeur. Modifiez également la valeur Gravité sur Afficher le repère. Cela déclenche le webhook associé à la règle ci-dessus et le propriétaire du projet reçoit une alerte SMS avec le Titre du problème, la Gravité et la Date d'échéance.