Configurer les Webhooks du projet

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 d’entreprise et de projet de permettre aux développeurs et intégrateurs tiers de s’abonner à des notifications d’événements pour une ou plusieurs ressources API Procore lorsque des actions de création, de mise à jour ou de suppression se produisent. Par exemple, une intégration de DDR tierce peut souhaiter être avertie chaque fois qu’une nouvelle DDR est créée dans Procore.

Les avantages de la fonctionnalité 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 transfèrent 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 tierces 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 demandes d’API par le biais de l’interrogation peut entraîner des économies de coûts significatives, en particulier pour les applications qui traitent de gros volumes de données.

• Informations sur l’administrateur :

  • « Admin » dans l’outil Admin des projets.

• Informations pour les développeurs :

  • Reportez-vous aux guides Introduction aux Webhooks et à l’utilisation de l’API Webhooks sur le portail des développeurs pour plus d’informations sur le développement de votre application ou de votre intégration afin de prendre correctement en charge les Webhooks.

1. Accédez à l’outil Admin au niveau projet.

2. Sous « Paramètres du projet », cliquez sur Webhooks.

3. Sur la page Webhooks, cliquez sur Créer une accroche.
   
   Ceci ouvre une nouvelle page de configuration de hook qui comprend un certain nombre de champs et de contrôles pour la configuration d’un hook.

4. Remplissez les champs de configuration du point de terminaison comme suit :
   

   • URL du point de terminaison : saisissez 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) : saisissez le jeton d’autorisation que vous souhaitez voir placé dans l’en-tête de la requête POST envoyée depuis Procore. Bien que ce champ puisse être utilisé pour définir toutes les informations d’en-tête d’autorisation que vous souhaitez, il est le plus souvent utilisé pour spécifier les informations d’autorisation pour le serveur tiers. Par exemple, une entrée valide pour ce champ pourrait être « De base 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 d’entité Webhooks

5. Dans la carte Sélectionner les événements à envoyer , cliquez sur les icônes de flèches pour développer les ensembles d’outils, puis cochez les cases des événements que vous souhaitez inclure :
   

6. Sous Événements sélectionnés, passez en revue votre liste et cliquez sur le X pour supprimer tous les événements nécessaires.
   

Once a hook is created and configured, you can view the status of the events that Procore has sent to the third-party service.The Overview section provides a high-level summary of the hook including the hook status and other relevant information.

The Events section displays the event history for the selected hook. The event history is maintained for a rolling 28-day period.

Each event is identified by its Resource Name, Resource ID, Event Type, Event Status, and Timestamp in UTC.

Possible values for Event Status are as follows:

• Delivered - the event has been successfully delivered to the third-party service.

• Discarded - the event has been discarded. No further delivery attempts will be made.

• Failed - the event delivery has failed.

• Queued - the event has been queued for delivery to the third-party service.

• Retrying - delivery of the event is being attempted again.

You can perform a variety of actions with the Events list:

• Search for events on a specific resource by resource ID.

• Use the Resource Name dropdown to show only the events for the selected resource.

• Use the Event Status dropdown to show only the events with the selected event status.

• Use the Filter button to create a custom filter on the events list.

• Click on an individual event in the list to view details.