HireHop kan skicka ett meddelande med data till andra appar när vissa händelser utlöses inom HireHop. Detta meddelande kallas en webhook som automatiskt skickar relevant data till önskad plats.

WbhooksVad är en webhook?

En webhook skickar/skjuter ett meddelande, med data bifogad till meddelandet, när specifika saker händer i HireHop (en händelse). Webhooks skickas via HTTP (anropar en webbadress) och är ett sätt att skicka data till andra applikationer i realtid. Webhooks levererar relevant data till specifika applikationer när det händer, vilket innebär att den mottagande applikationen får data omedelbart efter händelsen inträffar, vilket är mycket effektivare och snabbare än polling efter dataändringar.

HireHop webhooks kan användas för att kommunicera direkt med andra appar eller skickas till en anslutning som Zapier, som kan göras för att formatera data och göra alla nödvändiga API-anrop tillbaka till HireHop eller till en annan applikation.

Konfigurera en webhook

I HireHop, gå till ”Inställningar” och klicka sedan på fliken ”Företagsinställningar” och knappen ”Webhooks” högst upp på sidan. I popup-fönstret, klicka på knappen ”Ny” och lägg till URL:en dit webhookmeddelandet ska skickas till och välj varje webhook som du vill att URL:en ska svara på. Du kan lägga till så många webhooks som du vill, men bör begränsa dem till endast de nödvändiga som den specifika webbadressen kommer att svara på.

En HireHop webhook kommer att POSTA data till din URL-slutpunkt som JSON, och kommer att innehålla följande eller liknande data.

{
    "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": "gammal",
            "to": "ny"
        }, ...
    }
}

I JSON-exemplet ovan är följande fält:

  • ”time” är UTC-tiden och datumet då webhook skickades.
  • ”user_id” är ID för användaren som orsakade att händelsen utlöstes.
  • ”user_name” är deras användarnamn.
  • ”company_id”-fältet är den unika nummeridentifieraren för företaget som användaren arbetar för.
  • ”export_key” är värdet på exportnyckeln i företagsinställningar som kan användas som en säkerhetskontroll.
  • ”event” är namnet på webhook-händelsen som utlöstes.
  • ”data” är den data som hör till webhook-händelsen.
  • ”changes” är de fält som förändrats, vilket är vad de var till vad de ändrades till.

HireHop kommer inte att vänta på ett svar från den anropade URL:en eller rapportera ett HTTP-fel från att anropa den.

Exempel på PHP-kod för en URL-slutpunkt för att fånga webhook-data skulle vara:

<?php
	// Hämta JSON-data
	$postdata = file_get_contents('php://input');
	// Konvertera JSON-data till ett objekt
	$data_str = json_decode($postdata);
?>

 

Posted on by Justin Levene
Posted in API