Wie Webhooks in HireHop funktionieren

HireHop kann eine Nachricht mit Daten an andere Apps senden, wenn bestimmte Ereignisse in HireHop ausgelöst werden. Diese Nachricht wird als Webhook bezeichnet und überträgt die relevanten Daten automatisch an den gewünschten Ort.

Was ist ein Webhook?

Ein Webhook sendet bzw. pusht eine Nachricht mit angehängten Daten, wenn bestimmte Dinge in HireHop passieren (ein Ereignis). Webhooks werden über HTTP gesendet (rufen eine Webadresse auf) und sind eine Möglichkeit, Daten in Echtzeit an andere Anwendungen zu pushen. Webhooks übermitteln die relevanten Daten an bestimmte Anwendungen, sobald sie auftreten, was bedeutet, dass die empfangende Anwendung Daten unmittelbar nach dem Ereignis erhält, was weitaus effizienter und schneller ist als das Abfragen (Polling) von Datenänderungen.

HireHop-Webhooks können verwendet werden, um direkt mit anderen Apps zu kommunizieren, oder an einen Connector wie Zapier gesendet werden, der so konfiguriert werden kann, dass er die Daten formatiert und alle erforderlichen API-Aufrufe zurück an HireHop oder an eine andere Anwendung tätigt.

Einrichten eines Webhooks

Gehen Sie in HireHop zu Einstellungen, klicken Sie dann auf das Register Firmeneinstellungen und anschließend auf die Schaltfläche Webhooks oben auf der Seite. Klicken Sie im Popup-Fenster auf die Schaltfläche Neu, fügen Sie die URL hinzu, an die die Webhook-Nachricht gesendet werden soll, und wählen Sie jeden Webhook aus, auf den die URL reagieren soll. Sie können beliebig viele Webhooks hinzufügen, sollten diese jedoch auf das Notwendigste beschränken, auf das die jeweilige URL reagieren muss.

Ein HireHop-Webhook sendet Daten per POST als JSON an Ihren URL-Endpunkt und enthält ähnliche oder folgende Daten:

{
    "time": "2022-03-29 07:50:42",
    "user_id": 1,
    "user_name": "John Smith",
    "user_email": "john@email.com",
    "company_id": 1,
    "export_key": "22u43mrjwe7u",
    "event": "invoice.status.updated",
    "data": { ... },
    "changes": {
        "FIELD_NAME": {
            "from": "old",
            "to": "new"
        }, ...
    }
}

Im obigen JSON-Beispiel haben die folgenden Felder folgende Bedeutung:

  • “Zeitist die UTC-Zeit und das Datum, zu dem der Webhook gesendet wurde.
  • “user_idist die ID des Benutzers, der das Auslösen des Ereignisses verursacht hat.
  • “user_nameist der Name dieses Benutzers.
  • “company_id”-Feld ist die eindeutige Nummernkennung des Unternehmens, für das der Benutzer arbeitet.
  • “export_key” ist der Wert des Exportschlüssels in den Firmeneinstellungen, der als Sicherheitsüberprüfung verwendet werden kann.
  • “Ereignis” ist der Name des ausgelösten Webhook-Ereignisses.
  • “Daten” sind die Daten, die sich auf das Webhook-Ereignis beziehen.
  • “Änderungen” sind die Felder, die sich geändert haben, und zwar von ihrem vorherigen zu ihrem neuen Wert.

HireHop wartet nicht auf eine Antwort der aufgerufenen URL und meldet keinen HTTP-Fehler beim Aufruf.

Beispiel-PHP-Code für einen URL-Endpunkt zum Erfassen der Webhook-Daten:

<?php
	// Read the JSON data
	$postdata = file_get_contents('php://input');
	// Convert JSON data to an object
	$data_str = json_decode($postdata);
?>