Was sind Webhooks?

Verstehen, was Webhooks sind und welchen Zweck sie erfüllen.

📘"Klopf klopf auf X außerhalb von Factorial, wenn Y innerhalb von Factorial passiert"

🚧 Nutzung

Webhooks können direkt oder über zwischengeschaltete Plattformen oder Dienste verwendet werden. Die direkte Nutzung erfordert technische Kenntnisse.

Webhooks ermöglichen es Ihnen, Integrationen zu erstellen oder einzurichten, z. B. die Synchronisierung zwischen Plattformen oder die Durchführung einer Aktion nach Eintreten eines bestimmten Ereignisses. Wenn eines dieser Ereignisse ausgelöst wird, wird eine HTTP POST-Nutzlast an die konfigurierte URL des Webhooks gesendet. Webhooks können verwendet werden, um ein externes LDAP zu aktualisieren, Prozesse auszulösen, eine andere Anwendung zu aktualisieren oder sogar eine Verbindung zu einer anderen Plattform herzustellen, um andere Ereignisse auszuführen. 

Factorial Webhooks

In Factorial passieren ständig Tausende von Dingen, ohne dass jemand weiß, wann sie passieren, und das ist auch gut so, denn sie alle zu kennen, ist nicht sinnvoll und wird wahrscheinlich nur für Verwirrung sorgen.
Aber es gibt ein paar, die nützlich zu wissen sind. Wir müssen wissen, wann diese Ereignisse eintreten und welche Informationen damit verbunden sind. Aus diesem Grund gibt es Endpunkte, an denen URLs mit verschiedenen Ereignissen verknüpft werden können.

🚧URL

Es kann dieselbe URL verwendet werden, um Benachrichtigungen für alle Ereignisse zu erhalten, oder verschiedene URLs pro Ereignis. Wenn für alle Ereignisse dieselbe URL für den Empfang von Benachrichtigungen verwendet wird, kann es schwierig sein, ein Ereignis von einem anderen zu unterscheiden.

Wenn ein Ereignis in Factorial eintritt, wird eine POST-Anfrage an die zugehörige Ereignis-URL ausgelöst. Schlägt die Anfrage aus irgendeinem Grund fehl, wird kurz darauf ein erneuter Versuch unternommen.

Abonnieren

Das Abonnieren eines Webhooks ist sehr einfach, obwohl technische Kenntnisse erforderlich sind. Nach Erhalt eines Oauth2-Tokens oder eines ApiKey-Anmeldedatensatzes ist eine einfache Curl-Anfrage mit der Ereignis-ID und der URL alles, was erforderlich ist.

curl --request POST \ --url https://api.factorialhr.com/api/v1/webhooks \ --header 'Accept: application/json' \ --header 'Authorization: Bearer TOKEN' \ --header 'Content-Type: application/json' \ --data ' { "type": "employee_unterminated", "target_url": "https://foo.com/webhooks/employee_unterminated" } '

🚧 Bestehender Webhook

Wenn bereits ein Webhook für ein Ereignis existiert, wird beim Erstellen eines neuen Abonnements das vorherige Abonnement überschrieben.

Abbestellen

Um einen Webhook zu löschen oder das Abonnement eines Ereignisses zu beenden, führen Sie einfach eine DELETE-Anfrage mit der Ereignis-ID aus.

curl --request DELETE \ --url https://api.factorialhr.com/api/v1/webhooks \ --header 'Accept: application/json' \ --header 'Authorization: Bearer TOKEN' \ --header 'Content-Type: application/json' \ --data ' { "type": "employee_invited" } '

Liste

Um die aktuell konfigurierten Webhooks anzuzeigen, führen Sie den folgenden Curl aus. (weitere Informationen in der Api-Dokumentation)

curl --request GET \ --url https://api.factorialhr.com/api/v1/webhooks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer TOKEN'