Skip to main content
Procore

Configurer les Webhooks de la compagnie

Objectif

Configurer la fonction Webhooks pour recevoir des notifications lorsqu'une ou plusieurs ressources API Procore changent au niveau de la compagnie.

Contexte

La fonction Webhooks permet aux développeurs et intégrateurs tiers de spécifier une ou plusieurs ressources API Procore pour lesquelles ils souhaitent être notifiés lors d'actions de création, de mise à jour ou de suppression. L'interface utilisateur pour la configuration de la fonction Webhooks est disponible via l'outil Admin de la compagnie dans Procore.

Les avantages de la fonction Webhooks sont notamment les suivants :

  • Supprimer la nécessité d'une logique/d’un code de sondage dans les intégrations de tiers pour déterminer les changements de ressources
  • Amélioration des performances en remplaçant les sondages par des mises à jour asynchrones
  • Efficacité accrue car le code ne doit fonctionner que lorsqu'une ressource change
  • Réduction du risque de dépassement des plafonds de taux API de Procore

Éléments à considérer

  • Permission d'utilisateur requise :
    • Permission de niveau « Admin » dans l'outil Admin de la compagnie.
  • Informations pour les développeurs :
    • Se référer aux guides Introduction à Webhooks et Utilisation de l'API Webhooks sur le portail des développeurs pour obtenir des informations sur le développement ou sur l'intégration de votre application, afin de prendre en charge correctement les Webhooks.

Étapes

  1. Naviguez vers l'outil Admin de la compagnie.  
    Cela révèle la page Paramètres de la compagnie. 
  2. Sous « Paramètres administratifs », cliquez sur Webhooks.
    Cela ouvre la page de configuration de « Webhooks » qui comprend un champ Point d’extrémité de notification pour entrer l'URL de votre serveur Web et une grille de ressources pour sélectionner les ressources et les actions de modification correspondantes pour lesquelles vous souhaitez recevoir une notification.


    company_webhooks_config.png

 

  1. Faites ce qui suit :
  2. Dans la grille de ressources, cochez les cases « Créer », « Mettre à jour » et « Supprimer » pour toute ressource pour laquelle vous souhaitez recevoir les notifications correspondantes. Notez que vos sélections d'actions prennent effet immédiatement dès que vous les faites, il n'est pas nécessaire de « soumettre » vos modifications.
    Remarque :  Gardez à l'esprit que, lorsque vous configurez des Webhooks , vous ne faites qu'identifier les ressources/actions sur lesquelles vous souhaitez recevoir des notifications. Vous ne recevrez une notification que lorsqu'une modification réelle sera apportée à une ressource.

Livraisons Webhooks 

Edit section

Un registre des livraisons Webhooks vers votre point d’extrémité de notification est disponible en bas de la page Webhooks de la compagnie. La section Livraisons permet de voir rapidement le statut des événements que Procore a envoyé (ou a tenté d'envoyer) à votre serveur de notification. Les livraisons réussies et les échecs sont affichés par défaut. Vous pouvez utiliser la case « Afficher uniquement les échecs » pour filtrer l'affichage afin de n'afficher que les échecs de livraison.

 

 

Les livraisons les plus récentes apparaissent en haut de la section Livraisons. En cliquant sur une entrée de livraison, vous obtenez des détails sur la charge utile de la demande, les en-têtes de réponse et le corps de la réponse.

 

deliveries-expand-project.png

 

L'affichage du registre des livraisons est paginé avec un maximum de 25 livraisons affichées à la fois. En cliquant sur « Plus de livraisons », vous verrez apparaître la prochaine série de 25 livraisons.

Surveillance et alarmes 

Edit section

Nous vous recommandons vivement de mettre en place une surveillance adéquate de vos serveurs de notification afin de garantir que toute interruption ou tout autre problème lié aux performances soit identifié et que vous soyez averti en temps utile par un système d'alarme fiable. Il existe de nombreux systèmes de surveillance commerciaux qui peuvent servir à cette fin, notamment DatadogNew Relicet d'autres encore. Ces services offrent des fonctions de surveillance robustes qui vous permettent de visualiser facilement la santé de votre système grâce à des tableaux et des graphiques configurables et à des analyses en temps réel. Ces services fournissent également des alertes intégrées, afin que vous soyez rapidement averti en cas de problème.

Voir aussi

  • Pour plus d'informations sur la configuration des Webhooks au niveau du projet, voir Configurer les Webhooks du projet.
  • Pour plus d'informations, reportez-vous aux documents inclus dans votre invitation bêta.