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.

WebhooksWas 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);
?>

 

Posted on by Justin Levene
Posted in API