Configurer les Webhooks du projet

Dernière mise à jour
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

Un webhook est un message automatisé, ou une requête HTTP, envoyé d’une application à une autre en temps réel lorsqu’un événement spécifique se produit, permettant des mises à jour de données en temps réel sans avoir besoin d’interrogations constantes ou de requêtes manuelles. Les Webhooks automatisent le processus de transfert de données entre les applications, éliminant ainsi la nécessité pour une application de vérifier constamment les mises à jour d’une autre.

Dans le contexte de Procore, la fonctionnalité Webhooks permet aux administrateurs de la compagnie et du projet de permettre aux développeurs et intégrateurs tiers de s’abonner aux notifications d’événements pour une ou plusieurs ressources de l’Procore API lorsque des actions de création, de mise à jour ou de suppression se produisent. Par exemple, une intégration tiers QRT peut souhaiter être avertie chaque fois qu’un nouveau QRT est créé dans Procore.

Les avantages de la fonction Webhooks sont notamment les suivants :

Permettre une communication instantanée entre Procore et les applications et services tiers. Au lieu d’attendre qu’une application demande des informations, les webhooks poussent les données de Procore dès qu’un événement se produit. Cela garantit que les systèmes sont toujours à jour.
Permettre l’automatisation des flux de travail en déclenchant des actions dans des applications tiers chaque fois que des événements spécifiques se produisent.
En éliminant le besoin d’interrogation constante, les webhooks réduisent la charge sur les serveurs et économisent la bande passante. Il en résulte une utilisation plus efficace des ressources.
La réduction du nombre de requêtes d’API par le biais de l’interrogation peut permettre de réaliser d’importantes économies, en particulier pour les applications qui traitent de gros volumes de données.

Éléments à considérer

Informations sur l’administrateur :
- « Admin » dans l'outil Admin du projet.
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.

Création d’un nouveau hook

Accédez à l’outil Admin au niveau projet.
Sous « Paramètres du projet », cliquez sur Webhooks.
Sur la page Webhooks, cliquez sur Créer une accroche.

Cela ouvre une nouvelle page de configuration de hook qui comprend un certain nombre de champs et de commandes pour la configuration d’un hook.

Configuration du point de terminaison :

URL du point de terminaison - Entrez l’URL du point de terminaison sur le serveur Web tiers qui gérera les demandes POST provenant de Procore lorsqu’un webhook est déclenché.
En-tête d’autorisation (facultatif) - Entrez le jeton d’autorisation que vous souhaitez placer dans l’en-tête de la demande POST envoyée depuis Procore. Bien que ce champ puisse être utilisé pour définir les informations d’en-tête d’autorisation souhaitées, il est le plus souvent utilisé pour spécifier les informations d’identification d’autorisation pour le serveur tiers. Par exemple, une entrée valide pour ce champ peut être « Basique c3a24b8208ac5199d083d54a1234e94b8864 ».
Format de la charge utile : sélectionnez la version de la charge utile de l’API REST que vous souhaitez envoyer au service tiers. Vous devrez travailler avec le développeur tiers pour comprendre quel format de charge utile est préféré. Notez qu’une fois le hook créé, la version de la charge utile ne peut pas être modifiée. Vous devrez supprimer et recréer le hook si vous devez modifier la version de la charge utile. Pour plus d’informations, consultez Formats de charge utile Webhooks

Sélectionnez les événements à envoyer :

Afficher les événements sélectionnés :

Vous pouvez passer en revue les événements de notification que vous avez sélectionnés et en supprimer certains si nécessaire.

Affichage des événements Webhooks

Une fois qu’un hook est créé et configuré, vous pouvez afficher le statut des événements que Procore a envoyés au service tiers.
La section Vue d’ensemble fournit un résumé de haut niveau du hook, y compris l’état du hook et d’autres informations pertinentes.

La section Événements affiche l’historique des événements du hook sélectionné. L’historique des événements est conservé pendant une période continue de 28 jours.

Chaque événement est identifié par son nom de ressource, son ID de ressource, son type d’événement, son statut d’événement et son Horodatage en UTC.

Les valeurs possibles pour l’état de l’événement sont les suivantes :

Livré : l’événement a été livré avec succès au service tiers.
Ignoré : l’événement a été ignoré. Aucune autre tentative de livraison ne sera effectuée.
Échec : la livraison de l’événement a échoué.
En file d’attente : l’événement a été mis en file d’attente pour être remis au service tiers.
Nouvelle tentative : la remise de l’événement est à nouveau tentée.

Vous pouvez effectuer diverses actions avec la liste Événements :

Recherchez des événements sur une ressource spécifique par ID de ressource.
Utilisez la liste déroulante Nom de la ressource pour afficher uniquement les événements de la ressource sélectionnée.
Utilisez la liste déroulante Statut de l’événement pour afficher uniquement les événements avec le statut d’événement sélectionné.
Utilisez le bouton Filtre pour créer un filtre personnalisé dans la liste des événements.
Cliquez sur un événement individuel dans la liste pour afficher les détails.

Voir également

Pour plus d’informations sur la configuration des Webhooks au niveau de la compagnie, voir Configurer les Webhooks de la compagnie.
Les configurations de Webhook du projet sont prises en charge dans les modèles de projet. Pour plus d’informations, voir Configurer un modèle de projet.