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 :

Suppression du besoin de logique/code d'interrogation dans les intégrations tierces 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

Permissions d'utilisateur requises :
- Permissions de niveau « Admin » dans l'outil Admin au niveau de la compagnie.
Informations pour les développeurs :
- Reportez-vous à l’introduction aux Webhooks et à l’utilisation de l’API Webhooks guides sur le portail des développeurs pour plus d’informations sur le développement de votre application ou intégration pour prendre correctement en charge les Webhooks.

Étapes

Accédez à l'outil Admin au niveau de la compagnie.
Sous « Paramètres de la compagnie », cliquez sur Webhooks.
Cela ouvre la page de configuration « 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.

Procédez comme suit :
1. Point de terminaison de notification. Entrez l'URL du point de terminaison sur votre serveur Web qui gérera les demandes POST provenant de Procore.
2. En-tête de permission. (Facultatif) Saisissez le jeton de permission 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 de permission que vous souhaitez, il est le plus couramment utilisé pour spécifier les informations d'identification de permission à l'aide de la syntaxe : , où est le type de permission ('Basic', 'Token', 'Bearer', etc.) et est la valeur du jeton. Par exemple, une entrée valide pour ce champ serait De base c3a24b8208ac5199d083d54a1234e94b8864.
3. Enregistrer le point de terminaison. Cliquez sur ce bouton pour enregistrer le point de terminaison. Si vous avez entré une adresse valide et bien formée dans le champ Point de terminaison de notification, une bannière VERTE apparaît en haut de la page indiquant la réussite. 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.
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

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.

L'affichage du registre des livraisons est paginé avec un maximum de 25 livraisons affichées à la fois. Cliquez sur « Plus de livraisons », pour afficher la prochaine série de 25 livraisons.

Surveillance et alarmes

Nous vous recommandons fortement de configurer une surveillance appropriée de vos serveurs d’points de terminaison de notification pour vous assurer que tous les temps d’arrêt ou autres problèmes liés aux performances sont identifiés et que vous êtes informé en temps opportun via un système d’alarme fiable. De nombreux systèmes de surveillance commerciale sont disponibles à cet effet, y compris Dataodc, New Reliques, et d’autres. Ces services fournissent des fonctionnalités de surveillance robustes qui vous permettent de visualiser facilement la santé de votre système grâce à des graphiques configurables, des graphiques et des analyses en temps réel. Ces services fournissent également des alertes intégrées afin que vous soyez immédiatement informé lorsque des problèmes se produisent.

Voir également

Pour plus d’informations sur la configuration des Webhooks au niveau du projet, voir Configurer les Webhooks du projet.