Table des matières
Qu'est-ce qu'un webhook ?
Un webhook est un moyen de notifier une application tierce lorsqu'un événement défini dans survient.
Par exemple : vous pouvez déclencher la création d'un espace SharePoint lorsqu'un nouveau projet est créé dans .
🚩 Un mémo existe pour les webhooks, n'hésitez pas à le consulter pour plus d'informations
Liste des webhooks
Filtrer la liste des webhooks
Il faut cliquer sur 
Il n'est pas possible de changer la 
Droits requis
Actions générales
Création et modification d'un webhook
Cet écran permet d'ajouter un webhook à une plateforme et de le modifier.
Droits requis
Actions générales
Appliquer (apparaît une fois que l'on a testé le webhook)
Supprimer un Webhook
| Nom du bouton | Description |
|---|---|
🚦Ce bouton apparaît une fois que les 4 champs obligatoires (*) ont été remplis. Une fenêtre apparaît lorsque l'on clique sur ce bouton. Il est possible de choisir un projet, de tester le webhook ou d'annuler. |
Nom du champ | Informations fonctionnelles |
Ce champ permet de définir le nom du webhook. | |
Ce champ permet de décrire le webhook | |
Ce champ permet d'activer le webhook en cochant la case et de le désactiver en décochant la case. | |
Ce champ permet d'insérer une URL à appeler en HTTP ou HTTPS | |
Il s'agit de la méthode attendue par l'application tierce (GET, POST, PUT, PATCH, DEL) | |
Ce paramètre est à remplir pour les méthodes de type POST, PUT ou PATCH | |
Ce champ permet de saisir des paramètres, utilisés par exemple pour l'authentification. | |
Un mode d’appel parmi les deux suivants :
o Synchrone : L’action de l’utilisateur dans PM qui déclenche l’événement se termine quand la notification vers l’application tierce est terminée.
Si une erreur lors de l’appel à l’application tierce survient, le code statut en erreur est affiché à l’écran.
🚨Dans ce mode, les performances de sont altérées par le temps d’exécution du web service de l’application tierce.
▪ Synchrone exécuté dans la transaction : L’erreur empêche l’action dans .
▪ Synchrone exécuté en dehors de la transaction : L’action est exécutée même si la notification renvoie une erreur.
o Asynchrone : L’action se termine dans et la notification est faite à la suite. Si une erreur lors de la notification intervient, elle est visible uniquement dans les commandes en cours et dans le fichier de log de l’application. Il s’agit du paramétrage recommandé et par défaut.
Par exemple, si un utilisateur modifie une propriété d’un projet, appelle le web service désigné par le webhook associé.
Si on est en mode synchrone, attend le retour du web-service avant de finir l’action et de rendre la main à l’utilisateur. Si une erreur survient et que l’appel se fait dans la transaction, la modification de la propriété est annulée, sinon, si l’appel se fait en dehors de la transaction, la modification de la propriété est tout de même effectuée. Si on est en mode asynchrone, la modification de la propriété est effectuée et l’appel au web-service est fait par la suite, en tâche de fond. | |
Si la case est cochée : L’erreur empêche l’action dans .
Si la case est décochée : L’action est exécutée même si la notification renvoie une erreur.
Il n'est possible de cocher cette case uniquement si la case Synchrone est cochée. | |
Un événement doit être défini, par exemple une modification.
Plusieurs champs sont à remplir lorsque l'on souhaite choisir un événement, une fenêtre s'ouvre.
Il est possible d'annuler et de valider le choix.
Action : Choix entre Toutes actions, Création, Modification et Suppression.
Type d’objet : Choix entre Phase, Projet et Utilisateur.
Filtre projet : Choix d'un filtre projet créé (privé ou public) ou Tous les projets.
Si le type d'objet est Utilisateur, alors aucun filtre projet ne devra être choisi. |
💬 Si la configuration multilingue est activée, alors un champ supplémentaire est à remplir dans une section Multilingue. Ce champ correspond au libellé de l'objet dans l'autre langue.