HireHop kann eine Nachricht mit Daten an andere Apps senden, wenn bestimmte Ereignisse innerhalb von HireHop ausgelöst werden. Diese Nachricht wird als Webhook bezeichnet, der die relevanten Daten automatisch an die gewünschte Stelle verschiebt.

Was ist ein Webhook?

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

HireHop-Webhooks können verwendet werden, um direkt mit anderen Apps zu kommunizieren oder an einen Konnektor wie Zapier gesendet werden, der die Daten formatieren und alle erforderlichen API-Rückrufe an HireHop oder an eine andere Anwendung durchführen kann.

Einrichten eines Webhooks

Gehen Sie in HireHop zu „Einstellungen“, klicken Sie dann auf die Registerkarte „Unternehmenseinstellungen“ und die Schaltfläche „Webhooks“ oben auf der Seite. Klicken Sie im Popup-Fenster auf die Schaltfläche „Neu“ und 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 antworten soll. Sie können beliebig viele Webhooks hinzufügen, sollten sie jedoch auf die notwendigen beschränken, auf die die jeweilige URL reagiert.

Ein HireHop-Webhook sendet Daten als JSON an Ihren URL-Endpunkt und enthält die folgenden oder ähnliche 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": {
        "FELDNAME": {
            "from": "alt",
            "to": "neu"
        }, ...
    }
}

Im obigen JSON-Beispiel sind die folgenden Felder:

• „time“ ist die UTC-Zeit und das Datum, an dem der Webhook gesendet wurde.
• „user_id“ ist die ID des Benutzers, der das Auslösen des Ereignisses verursacht hat.
• „user_name“ ist der Name ihres Benutzers.
• „company_id“ ist die eindeutige Nummernkennung des Unternehmens, für das der Benutzer arbeitet.
• „export_key“ ist der Wert des Exportschlüssels in den Unternehmenseinstellungen, der als Sicherheitsüberprüfung verwendet werden kann.
• „event“ ist der Name des ausgelösten Webhook-Ereignisses.
• „data“ sind die Daten, die sich auf das Webhook-Ereignis beziehen.
• „changes“ sind die Felder, die sich geändert haben, dh das, was sie waren, zu dem, wozu sie geändert wurden.

HireHop wartet nicht auf eine Antwort von der aufgerufenen URL oder meldet einen HTTP-Fehler beim Aufruf.

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

<?php
	// Lesen Sie die JSON-Daten
	$postdata = file_get_contents('php://input');
	// Konvertieren Sie JSON-Daten in ein Objekt
	$data_str = json_decode($postdata);
?>

 

HireHop baut auf einer API auf, was bedeutet, dass Sie alles, was Sie von HireHop sehen, auch mit der umfangreichen API erreichen können. Um auf die Rest-API zuzugreifen, benötigen Sie lediglich ein Benutzertoken, das als GET oder POST auf den entsprechenden URL-Endpunkt angewendet wird.

API-Token

Um ein API-Token zu generieren, gehen Sie zur Seite „Einstellungen“ und wählen Sie die Registerkarte „Benutzer“. Wählen oder erstellen Sie einen Benutzer, klicken Sie dann, während dieser bestimmte Benutzer ausgewählt ist, auf die Schaltfläche „Menü“ und dann auf die Option „API-Token“, um ein Token zu generieren. Der Token wird dann angezeigt und kann mit der Schaltfläche Kopieren in die Zwischenablage kopiert werden.

Das Token wird ungültig, wenn Sie die E-Mail-Adresse oder das Passwort des ausgewählten Benutzers ändern oder sich anschließend bei diesem Benutzer anmelden. Um dies zu verhindern, sollten Sie einen dedizierten API-Benutzer erstellen und ihm aus Sicherheitsgründen die entsprechenden Berechtigungen erteilen, um ihn auf alles einzuschränken, für das Sie die API nicht verwenden.

Aus Sicherheitsgründen sollten Sie das Token nicht im Frontend-JavaScript-Code verwenden, es sollte nur serverseitig verwendet werden. Wenn ein Hacker den Token erhält, kann er Ihre Daten auf HireHop ändern und darauf zugreifen, also halten Sie Ihren Token geheim. Wenn Ihr Token durchgesickert ist, ändern Sie einfach das Passwort des API-Benutzers und generieren Sie einen neuen Token.

Verwenden eines Tokens

Ein Token sollte als GET- oder POST-Parameter festgelegt werden, der als „Token“ bezeichnet wird. Um beispielsweise Jobdaten für Jobnummer 52 zu laden, ruft HireHop den API-Endpunkt auf:

https://myhirehop.com/php_functions/job_refresh.php?job=52

Wenn Sie denselben Endpunkt mit einem Token aufrufen möchten, lautet die URL:

https://myhirehop.com/php_functions/job_refresh.php?job=52&token=dqwejk5GVT65909bHHBN7922pq5hxjm%207hmn

Bitte denken Sie daran, dass Sie bei der Übergabe des Tokens über GET (ein URL-Parameter wie oben) den Token zuerst mit einem Tool wie https://meyerweb.com/eric/tools/dencoder codieren müssen.

Buchungsdaten

Um Daten in HireHop zu erstellen oder zu bearbeiten, müssen Sie einen POST verwenden. Beim Veröffentlichen von Daten sollten Sie nur die Felder setzen, die Sie ändern möchten, um beispielsweise einen Job über den Endpunkt https://myhirehop.com/php_functions/job_save.php zu erstellen oder zu bearbeiten, indem Sie den Parameter „job“ auf „0“ setzen “ oder weglassen wird ein neuer Job erstellt, alles andere ändert die entsprechende Jobnummer. Um den Firmennamen in der Stellennummer 52 zu bearbeiten, sollten die Stellendaten wie folgt lauten:

{
"job" : 52,
"name" : "New Name",
"token" : "dqwejk5GVT65909bHHBN7922pq5hxjm=-7hmn"
}

API-Endpunkte

Viele API-Endpunkte sind in der API-Dokumentation dokumentiert, viele weitere werden folgen.  Um den Endpunkt für eine Aufgabe einzurichten, verwenden Sie in der HireHop-Anwendung die Browserkonsole, um die Netzwerkaufrufe und die eingestellten Parameter zu überprüfen. Eine ausführliche Anleitung zu den URL-Endpunkten wird in Kürze veröffentlicht.

Ratenbegrenzungen

HireHop erlaubt jedem Benutzer 60 Verbindungsanfragen innerhalb von 1 Minute. Wenn mehr als 60 vorhanden sind, wird der Fehler „Sicherheitswarnung, zu viele Transaktionen“ (327) zurückgegeben.