Passer au contenu principal
Procore

Configurer les webhooks du projet

  1. Dernière mise à jour
  2. Enregistrer en tant que PDF

Objectif

Configurez la fonctionnalité Webhooks pour recevoir des notifications lorsqu'une ou plusieurs ressources d'API Procore changent dans un projet.

Contexte

La fonctionnalité Webhooks permet aux développeurs et intégrateurs tiers de préciser une ou plusieurs ressources d'API Procore pour lesquelles ils souhaitent être avertis lorsque des activités de création, de mise à jour ou de suppression se produisent. L'interface utilisateur pour la configuration de la fonctionnalité Webhooks est disponible par l'entremise de l'outil Admin du projet dans Procore.

Les avantages de la fonctionnalité Webhooks sont notamment les suivants :

  • Suppression du besoin de logique/code de sondage dans les intégrations tierces afin de déterminer les modifications de ressources
  • Amélioration des performances en remplaçant les sondages par des mises à jour asynchrones
  • Efficacité accrue car le code ne doit être exécuté que lorsqu'une ressource change
  • Réduction du risque de dépassement des plafonds de taux API de Procore

Éléments à prendre en compte

  • Autorisations utilisateur requises :
    • « Admin » dans l'outil Admin du projet.
  • Informations pour les développeurs :
    • Reportez-vous 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.

Procédure

  1. Accédez à l'outil Admin du projet.
    Ceci affiche la page « Informations générales sur le projet ».
  2. Dans le menu « Paramètres du projet » de la barre latérale, cliquez sur Webhooks.

    project_settings_webhooks.png

    Ceci ouvre la page de configuration « Webhooks » qui comprend un champ Terminal de notification pour entrer l'URL de votre serveur Web, ainsi qu'une grille de ressources pour sélectionner les ressources et les actions de modification correspondantes pour lesquelles vous souhaitez recevoir une notification.

    project_webhooks_config.png

 

  1. Dans le champ Terminal de notification, saisissez l'URL du terminal sur votre serveur Web qui gérera les demandes POST provenant de Procore.
  2. (Facultatif) Dans le champ En-tête d'autorisation, saisissez le jeton d'autorisation que vous souhaitez placer dans l'en-tête d'une demande POST provenant de Procore. Bien que ce champ puisse être utilisé pour définir les informations d'en-tête d'autorisation souhaitées, il sert le plus souvent à spécifier les informations d'identification d'autorisation en utilisant la syntaxe : <type> <credential>, où <type> est le type d'autorisation (« Basic », « Token », « Bearer », etc.) et <credential> est la valeur du jeton. Par exemple, une entrée valide pour ce champ serait Basic c3a24b8208ac5199d083d54a1234e94b8864.
  3. Cliquez sur Enregistrer le terminal. Si vous avez entré une adresse valide et bien formatée dans le champ Terminal de notification, une bannière verte apparaît en haut de l'écran indiquant la réussite de l'opération. S'il y a des problèmes avec l'URL que vous avez entrée, une bannière d'avertissement s'affiche pour décrire le problème probable.
  4. Dans la grille de ressources, sélectionnez les actions « Créer », « Mettre à jour » et « Supprimer » pour toutes les ressources pour lesquelles vous souhaitez recevoir les notifications correspondantes. Notez que vos sélections d'actions prennent effet immédiatement au fur et à mesure ; il n'est pas nécessaire de « soumettre » vos modifications.

    Remarque : lors de la configuration des Webhooks, gardez à l'esprit que vous identifiez simplement les ressources/actions sur lesquelles vous souhaitez recevoir des notifications. Ce n'est qu'en cas de modification réelle d'une ressource que vous recevrez une notification.

Livraisons Webhooks

Un journal en cours d'exécution de livraisons Webhooks à votre terminal de notification est disponible au bas de la page Webhooks du projet. La section Livraisons permet de voir rapidement le statut des événements que Procore a envoyés (ou tenté d'envoyer) à votre serveur de notification. Les livraisons réussies et en échec sont incluses par défaut dans la vue. Vous pouvez utiliser la case à cocher Afficher uniquement les échecs pour filtrer la vue afin d'afficher uniquement les livraisons qui ont échoué.

 

deliveries.png

 

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 à la fois. En cliquant sur « Plus de livraisons », vous verrez apparaître la prochaine série de 25 livraisons.

more-deliveries.png

Surveillance et alarmes

Nous vous recommandons vivement de mettre en place une surveillance adéquate de vos serveurs de terminaux 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 Datadog, New Relic et d'autres encore. Ces services offrent de robustes fonctionnalités de surveillance qui vous permettent de visualiser facilement l'intégrité 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