Webhooks
Un webhook est une notification automatisée envoyée depuis le serveur de TARGPatrol vers le vôtre chaque fois qu'un événement spécifique se produit dans le système, tel qu'une tâche en cours de création, de mise à jour ou d'achèvement. Les Webhooks sont essentiels pour rationaliser les processus, s'intégrer à d'autres systèmes et répondre aux changements en temps réel. Lorsqu'un événement (par exemple, un changement de statut de tâche) se produit dans TARGPatrol, le système envoie une requête POST à une URL prédéfinie. Cette requête inclut une charge utile : un objet JSON contenant des détails sur l'événement tels que l'ID de la tâche, le statut et d'autres données pertinentes.
Comment configurer Webhooks dans TARGPatrol
Pour créer un webhook :
Connectez-vous à TARGPatrol.
Accédez au "Gestion" -> "Webhooks" rubrique.
Ajoutez un nouveau webhook :
Cliquez sur le Ajouter Webhook bouton.
Saisissez l'URL à laquelle les notifications doivent être envoyées. Assurez-vous que votre serveur est prêt à gérer les requêtes POST et à traiter les données JSON.
Sélectionnez les types d'événements qui déclencheront le webhook. TARGPatrol prend en charge divers déclencheurs.
Facultatif : ajoutez des en-têtes de demande : si nécessaire, spécifiez des en-têtes tels que Content-Type pour personnaliser le format de la demande.
Cliquez "Enregistrer" bouton.
Testez le webhook :
Après sauvegarde, TARGPatrol permet de tester le webhook en simulant un événement.
Par exemple, si votre webhook est configuré pour se déclencher sur task.created, vous recevrez une notification lorsqu'une nouvelle tâche est créée.
Webhook TASK_STEP_COMPLETED
Sélectionnez TASK_STEP_COMPLETED pour envoyer un webhook distinct chaque fois qu'une étape de tâche est terminée. Dans le sélecteur d'événements, il est affiché comme « tâche.étape terminée ».
La charge utile contient l'organisation, la tâche planifiée et l'historique des tâches, l'exécution de la tâche, l'emplacement, l'intervenant et l'indicateur d'enregistrement à la demande. L'objet étape peut inclure :
id, name, order et actualOrder : identification de l'étape, ordre global et ordre d'exécution réel.
pointId et pointHistoryId : références de points de contrôle lorsque l'étape utilise un point.
stepGroupId : la référence du groupe lorsque l'étape appartient à un groupe d'étapes.
état, statut, démarré à et terminé à : état d'exécution, résultat et horodatages.
Les champs facultatifs sont omis lorsqu'ils ne s'appliquent pas. Votre point de terminaison doit identifier l'événement par le type TASK_STEP_COMPLETED et gérer chaque étape terminée indépendamment.
Affichage des journaux Webhook dans TARGPatrol
Accédez aux journaux du webhook :
Ouvrez le « ZXQGARDER0QXZ » dans TARGPatrol.
Cliquez sur l'URL du webhook ou sur son icône pour afficher ses détails.
Une fenêtre affichera une liste des événements déclenchés, y compris leur statut, les charges utiles des requêtes et les réponses du serveur.
Rechercher les erreurs : si un webhook échoue, la demande correspondante sera marquée d'une icône d'erreur dans les journaux. TARGPatrol désactivera automatiquement un webhook après 25 requêtes consécutives ayant échoué.
Conseils pour gérer Webhooks
Gérez les erreurs avec élégance : Webhooks s'exécute en temps réel, mais si votre serveur ne répond pas, TARGPatrol retente automatiquement la demande.
Surveiller et analyser les erreurs : Des problèmes récurrents, tels que des délais d'attente, peuvent indiquer des problèmes de performances du serveur ou des erreurs de configuration de routage.
Restez informé : TARGPatrol envoie des alertes par e-mail lorsque de nouveaux webhooks sont créés, que des erreurs se produisent ou qu'un webhook est automatiquement désactivé. Cela vous tient informé de la santé de votre intégration.
Utilisez HTTPS pour la sécurité : Les webhooks TARGPatrol prennent uniquement en charge les URL HTTPS sécurisées pour garantir la sécurité des données.
La configuration de webhooks dans TARGPatrol vous permet d'automatiser les tâches, de les intégrer à d'autres systèmes et de gérer efficacement les données en temps réel. Suivez les conseils de gestion des webhooks pour éviter les pièges courants et garantir une intégration fluide. Utilisez HTTPS pour la sécurité, surveillez les erreurs pour résoudre les problèmes rapidement et restez informé de l'état de vos webhooks grâce aux alertes TARGPatrol. Avec la bonne configuration, vous rationaliserez les flux de travail et améliorerez la productivité de votre équipe.