Zu Hauptinhalten wechseln
Procore

Konfigurieren von Projekt-Webhooks

  1. Zuletzt aktualisiert
  2. Als PDF speichern

 

Ziel

Konfigurieren Sie die Webhooks-Funktion, um Benachrichtigungen zu erhalten, wenn sich eine oder mehrere Procore API-Ressourcen in einem Projekt ändern.

Hintergrund

Mit der Webhooks-Funktion können Entwickler und Integratoren von Drittanbietern eine oder mehrere Procore-API-Ressourcen angeben, für die sie benachrichtigt werden möchten, wenn Aktionen zum Erstellen, Aktualisieren oder Löschen auftreten. Die Benutzeroberfläche zum Konfigurieren der Webhooks-Funktion ist über das Admin-Tool des Projekts in Procore verfügbar.

Die Vorteile der Webhooks-Funktion umfassen:

  • Keine Abfragelogik/-code in Integrationen von Drittanbietern erforderlich, um Ressourcenänderungen zu bestimmen
  • Verbesserte Leistung durch Ersetzen von Polling durch asynchrone Aktualisierungen
  • Erhöhte Effizienz, da Code nur ausgeführt werden muss, wenn sich eine Ressource ändert
  • Reduziertes Risiko der Überschreitung der Procore API-Ratenlimitobergrenzen

Wichtige Hinweise

  • Erforderliche Benutzerberechtigung:
    • Admin im Administrations-Tool des Projekts.
  • Entwicklerinformationen:

Schritte

  1. Navigieren Sie zum Admin-Tool des Projekts.
    Dadurch wird die Seite „Allgemeine Projektinformationen“ angezeigt. 
  2. Klicken Sie in der Seitenleiste im Menü „Projekteinstellungen“ auf Webhooks.

    project_settings_webhooks.png

    Dadurch wird die Konfigurationsseite „Webhooks“ geöffnet, die ein Feld für den Benachrichtigungsendpunkt zum Eingeben Ihrer Webserver-URL und ein Ressourcenraster zum Auswählen der Ressourcen und entsprechenden Änderungsaktionen enthält, für die Sie eine Benachrichtigung erhalten möchten.

    project_webhooks_config.png

 

  1. Geben Sie im Feld Benachrichtigungsendpunkt die URL für den Endpunkt auf Ihrem Webserver ein, der die POST-Anfragen von Procore verarbeitet.
  2. (Optional) Geben Sie im Feld Autorisierungs-Header das Autorisierungstoken ein, das Sie in den Header einer POST-Anfrage von Procore einfügen möchten. Obwohl dieses Feld verwendet werden kann, um beliebige Autorisierungs-Header-Informationen zu definieren, wird es am häufigsten verwendet, um Autorisierungs-Anmeldeinformationen mit der folgenden Syntax anzugeben: <type> <credential>, wobei <type> der Autorisierungstyp ist ('Basic', 'Token ', 'Bearer' usw.) und <credential> ist der Tokenwert. Ein gültiger Eintrag für dieses Feld wäre beispielsweise Basic c3a24b8208ac5199d083d54a1234e94b8864.
  3. Klicken Sie auf Endpunkt speichern. Wenn Sie eine gültige, korrekte Adresse in das Feld Benachrichtigungsendpunkt eingegeben haben, wird oben auf dem Bildschirm ein grünes Banner angezeigt, das den Erfolg anzeigt. Bei Problemen mit der eingegebenen URL wird ein Warnbanner mit einer Beschreibung des wahrscheinlichen Problems angezeigt.
  4. Im Resourcenraster wählen Sie die Aktionen ‚Erstellen‘, ‚Aktualisieren‘ und ‚Löschen‘ für alle Ressourcen, die Sie entsprechende Benachrichtigungen erhalten mögen. Beachten Sie, dass Ihre Aktionsauswahlen sofort wirksam werden, wenn Sie sie vornehmen. Sie müssen Ihre Änderungen nicht ‚übermitteln‘.

    Hinweis: Denken Sie beim Konfigurieren von Webhooks daran, dass Sie lediglich angeben, zu welchen Ressourcen/Aktionen Sie Benachrichtigungen erhalten möchten. Erst bei einer tatsächlichen Änderung einer Ressource erhalten Sie dann eine Benachrichtigung.

Webhooks-Zustellungen

Ein ausgeführtes Protokoll der Webhooks-Zustellungen an Ihren Benachrichtigungsendpunkt ist unten auf der Seite Project Webhooks verfügbar. Im Abschnitt Zustellungen können Sie schnell den Status von Ereignissen sehen, die Procore an Ihren Benachrichtigungsserver gesendet hat (oder versucht hat zu senden). Sowohl erfolgreiche als auch fehlgeschlagene Lieferungen werden standardmäßig in der Anzeige angezeigt. Sie können das Kontrollkästchen „Nur Fehler anzeigen“ verwenden, um die Anzeige so zu filtern, dass nur fehlgeschlagene Zustellungen angezeigt werden.

 

deliveries.png

 

Die letzten Zustellungen werden oben im Zustellungen-Abschnitt angezeigt. Wenn Sie auf einen Zustellungseintrag klicken, werden Details zur Anforderungsnutzlast, den Antwortheadern und dem Antworttext angezeigt.

 

deliveries-expand-project.png

Die Anzeige des Zustellungsprotokolls ist paginiert mit maximal 25 gleichzeitig angezeigten Zustellungen. Wenn Sie auf Weitere Lieferungen klicken, wird der nächste Satz von 25 Zustellungen angezeigt.

more-deliveries.png

Überwachung und Alarme

Wir empfehlen Ihnen dringend, eine angemessene Überwachung Ihrer Benachrichtigungsendpunkt-Server einzurichten, um sicherzustellen, dass etwaige Ausfallzeiten oder andere leistungsbezogene Probleme erkannt und Sie rechtzeitig über ein zuverlässiges Alarmsystem benachrichtigt werden. Es gibt viele kommerzielle Überwachungssysteme, die diesen Zweck erfüllen können, darunter Datadog, New Relic, und andere. Diese Dienste bieten robuste Überwachungsfunktionen, mit denen Sie den Zustand Ihres Systems anhand von konfigurierbaren Diagrammen, Grafiken und Echtzeit-Analysen einfach visualisieren können. Diese Dienste bieten auch eine integrierte Warnfunktion, so dass Sie sofort benachrichtigt werden, wenn Probleme auftreten.

Siehe auch