Konfigurieren von Projekt-Webhooks

Ziel

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

Hintergrund

Ein Webhook ist eine automatisierte Nachricht oder eine HTTP-Anforderung, die beim Eintreten eines bestimmten Ereignisses in Echtzeit von einer Anwendung an eine andere gesendet wird und Datenaktualisierungen in Echtzeit ermöglicht, ohne dass ständige Abfragen oder manuelle Anfragen erforderlich sind. Webhooks automatisieren den Prozess der Datenübertragung zwischen Anwendungen, sodass eine Anwendung nicht mehr ständig nach Updates von einer anderen suchen muss.

Im Kontext von Procore ermöglicht die Webhooks-Funktion Unternehmens- und Projektadministratoren, Drittanbieter-Entwicklern und -Integratoren zu ermöglichen, Ereignisbenachrichtigungen für eine oder mehrere Procore API-Ressourcen zu abonnieren, wenn Erstellungs-, Aktualisierungs- oder Löschaktionen stattfinden. Beispielsweise kann eine Rückfrage-Integration eines Drittanbieters benachrichtigt werden wollen, wenn eine neue Rückfrage in Procore erstellt wird.

Die Vorteile der Webhooks-Funktion umfassen:

• Sofortige Kommunikation zwischen Procore und Anwendungen und Diensten von Drittanbietern. Anstatt darauf zu warten, dass eine Anwendung Informationen anfordert, übertragen Webhooks Daten von Procore, sobald ein Ereignis eintritt. So ist sichergestellt, dass die Systeme immer auf dem neuesten Stand sind.

• Ermöglichung der Automatisierung von Workflows durch Auslösen von Aktionen in Anwendungen von Drittanbietern, wenn bestimmte Ereignisse eintreten.

• Durch den Wegfall der Notwendigkeit ständiger Abfragen reduzieren Webhooks die Last auf den Servern und sparen Bandbreite. Dies führt zu einer effizienteren Nutzung von Ressourcen.

• Die Reduzierung der Anzahl der API-Anfragen durch Abfragen kann zu erheblichen Kosteneinsparungen führen, insbesondere bei Anwendungen, die große Datenmengen verarbeiten.

Wichtige Hinweise

• Administrator-Informationen:
  • Admin im Administrations-Tool des Projekts.
• Entwicklerinformationen:
  • Informationen zur Entwicklung Ihrer Anwendung oder Integration für die korrekte Unterstützung von Webhooks finden Sie in den Handbüchern Introduction to Webhooks und Using the Webhooks API auf dem Developer Portal.

Erstellen eines neuen Hooks

1. Navigieren Sie zum Admin-Tool auf Projektebene. 

2. Klicken Sie unter "Projekteinstellungen" auf Webhooks.

3. Klicken Sie auf der Seite Webhooks auf Hook erstellen.

Dadurch wird eine neue Hook-Konfigurationsseite geöffnet, die eine Reihe von Feldern und Steuerelementen für die Konfiguration eines Hooks enthält.

4. Endpunkt-Konfiguration:

• Endpunkt-URL - Geben Sie die URL für den Endpunkt auf dem Drittanbieter-Webserver ein, der die POST-Anfragen verarbeitet, die von Procore kommen, wenn ein Webhook ausgelöst wird.
• Autorisierungs-Header (optional) - Geben Sie das Autorisierungs-Token ein, das im Header für die von Procore gesendete POST-Anfrage platziert werden soll. Obwohl dieses Feld verwendet werden kann, um beliebige Informationen im Autorisierungs-Header zu definieren, wird es am häufigsten verwendet, um Anmeldedaten für die Autorisierung für den Drittanbieter-Server anzugeben. Ein gültiger Eintrag für dieses Feld könnte z. B. "Basic c3a24b8208ac5199d083d54a1234e94b8864" lauten.
• Payload-Format : Wählen Sie die REST-API-Payload-Version aus, die Sie an den Drittanbieter-Dienst senden möchten. Sie müssen mit dem Drittanbieter-Entwickler zusammenarbeiten, um zu verstehen, welches Payload-Format bevorzugt wird. Beachten Sie, dass die Payload-Version nicht mehr geändert werden kann, sobald der Hook erstellt wurde. Sie müssen den Hook löschen und neu erstellen, wenn Sie die Payload-Version ändern müssen. Weitere Informationen finden Sie unter Webhooks-Nutzlastformate

5. Wählen Sie die zu versendenden Ereignisse aus:

6. Ausgewählte Ereignisse anzeigen:

Sie können die von Ihnen ausgewählten Benachrichtigungsereignisse überprüfen und bei Bedarf einige entfernen.

Anzeigen von Webhooks-Ereignissen

Sobald ein Hook erstellt und konfiguriert ist, können Sie den Status der Ereignisse einsehen, die Procore an den Drittanbieter-Dienst gesendet hat.
Der Abschnitt Übersicht bietet eine allgemeine Zusammenfassung des Hooks, einschließlich des Hook-Status und anderer relevanter Informationen.

Im Abschnitt Ereignisse wird der Ereignisverlauf für den ausgewählten Hook angezeigt. Der Ereignisverlauf wird für einen rollierenden Zeitraum von 28 Tagen beibehalten.

Jedes Ereignis wird durch den Ressourcennamen, die Ressourcen-ID, den Ereignistyp, den Ereignisstatus und den Zeitstempel in UTC identifiziert.

Mögliche Werte für Event Status lauten wie folgt:

• Übermittelt: Das Ereignis wurde erfolgreich an den Drittanbieter-Dienst übermittelt.

• Verworfen - Das Ereignis wurde verworfen. Es werden keine weiteren Zustellversuche unternommen.

• Fehlgeschlagen: Die Ereignisübermittlung ist fehlgeschlagen.

• In der Warteschlange: Das Ereignis wurde für die Übermittlung an den Drittanbieter-Dienst in die Warteschlange gestellt.

• Erneuter Versuch: Es wird erneut versucht, das Ereignis zu übermitteln.

Mit der Ereignisliste können Sie eine Vielzahl von Aktionen durchführen:

• Suchen Sie anhand der Ressourcen-ID nach Ereignissen für eine bestimmte Ressource.

• Verwenden Sie die Dropdown-Liste Ressourcenname, um nur die Ereignisse für die ausgewählte Ressource anzuzeigen.

• Verwenden Sie die Dropdown-Liste Ereignisstatus, um nur die Ereignisse mit dem ausgewählten Ereignisstatus anzuzeigen.

• Verwenden Sie die Schaltfläche Filter, um einen benutzerdefinierten Filter für die Ereignisliste zu erstellen.

• Klicken Sie auf ein einzelnes Ereignis in der Liste, um Details anzuzeigen.

Siehe auch

• Informationen zur Konfiguration von Webhooks auf Unternehmensebene finden Sie unter Configure Company Webhooks.
• Projekt-Webhook-Konfigurationen werden in Projektvorlagen unterstützt. Weitere Informationen finden Sie unter Eine Projektvorlage konfigurieren.