HireHop può inviare un messaggio con dati ad altre app quando determinati eventi vengono attivati all’interno di HireHop. Questo messaggio è chiamato webhook che invia automaticamente i dati rilevanti nella posizione richiesta.

WebhooksCos’è un webhook?

Un webhook invia/spinge un messaggio, con i dati allegati al messaggio, quando accadono cose specifiche in HireHop (un evento). I webhook vengono inviati tramite HTTP (chiama un indirizzo web) e sono un modo per inviare dati ad altre applicazioni in tempo reale. I webhook forniscono i dati rilevanti ad applicazioni specifiche non appena si verificano, il che significa che l’applicazione ricevente ottiene i dati immediatamente dopo che si verifica l’evento, il che è molto più efficiente e veloce del polling per le modifiche ai dati..

I webhook HireHop possono essere utilizzati per comunicare direttamente con altre app o essere inviati a un connettore come Zapier, che può essere creato per formattare i dati ed effettuare le chiamate API necessarie a HireHop o a un’altra applicazione.

Configurazione di un webhook

In HireHop, vai su “Impostazioni”, quindi fai clic sulla scheda “Impostazioni azienda” e sul pulsante “Webhook” nella parte superiore della pagina. Nella finestra popup, fai clic sul pulsante “Nuovo” e aggiungi l’URL a cui deve essere inviato il messaggio webhook e seleziona ogni webhook a cui desideri che l’URL risponda. Puoi aggiungere tutti i webhook che desideri, ma dovresti limitarli solo a quelli necessari a cui risponderà l’URL specifico.

Un webhook HireHop pubblicherà i dati sull’endpoint URL come JSON e conterrà i dati seguenti o simili.

{
    "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": "vecchio",
            "to": "nuovo"
        }, ...
    }
}

Nell’esempio JSON sopra, i seguenti campi sono:

  • time” è l’ora UTC e la data in cui è stato inviato il webhook.
  • user_id” è l’ID dell’utente che ha causato l’attivazione dell’evento.
  • user_name” è il nome dell’utente.
  • company_id” è l’identificatore numerico univoco dell’azienda per cui l’utente lavora.
  • export_key” è il valore della chiave di esportazione nelle impostazioni dell’azienda che può essere utilizzata come controllo di sicurezza.
  • event” è il nome dell’evento webhook che è stato attivato.
  • data” sono i dati che appartengono all’evento webhook.
  • changes” sono i campi che sono cambiati, essendo ciò che erano rispetto a ciò in cui sono stati modificati.

HireHop non attende una risposta dall’URL chiamato né segnala un errore HTTP durante la sua chiamata.

Il codice PHP di esempio per un endpoint URL per acquisire i dati del webhook sarebbe:

<?php
	// Ottieni i dati JSON
	$postdata = file_get_contents('php://input');
	// Converti i dati JSON in un oggetto
	$data_str = json_decode($postdata);
?>

 

Posted in API