HireHop puede enviar un mensaje con datos a otras aplicaciones cuando se activan ciertos eventos dentro de HireHop . Este mensaje se denomina webhook que envía automáticamente los datos relevantes a la ubicación requerida.
¿Qué es un webhook?
Un webhook envía/empuja un mensaje, con datos adjuntos al mensaje, cuando suceden cosas específicas en HireHop (un evento). Los webhooks se envían a través de HTTP (llaman a una dirección web) y son una forma de enviar datos a otras aplicaciones en tiempo real. Los webhooks entregan los datos relevantes a aplicaciones específicas a medida que ocurren, lo que significa que la aplicación receptora obtiene los datos inmediatamente después de que ocurre el evento, lo que es mucho más eficiente y rápido que buscar cambios en los datos.
Los webhooks de HireHop se pueden usar para comunicarse directamente con otras aplicaciones o se pueden enviar a un conector como Zapier, que se puede hacer para formatear los datos y realizar las llamadas API necesarias a HireHop o a otra aplicación.
Configuración de un webhook
En HireHop, vaya a «Configuración», luego haga clic en la pestaña «Configuración de la empresa» y en el botón «Webhooks» en la parte superior de la página. En la ventana emergente, haga clic en el botón «Nuevo» y agregue la URL a la que se enviará el mensaje del webhook y seleccione todos los webhooks a los que desea que responda la URL. Puede agregar tantos webhooks como desee, pero debe limitarlos solo a los necesarios a los que responderá la URL específica.
Un webhook de HireHop publicará datos en su punto final de URL como JSON y contendrá los siguientes datos o datos similares.
{
"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": "antiguo",
"to": "nuevo"
}, ...
}
}
En el ejemplo JSON anterior, los siguientes campos son:
- «time» es la hora UTC y la fecha en que se envió el webhook.
- «user_id» es el ID del usuario que provocó que se desencadenara el evento.
- «user_name» es el nombre de su usuario.
- «company_id» es el identificador de número único de la empresa para la que trabaja el usuario.
- «export_key» es el valor de la clave de exportación en la configuración de la empresa que se puede utilizar como control de seguridad.
- «event» es el nombre del evento de webhook que se activó.
- «data» son los datos que pertenecen al evento webhook.
- «changes» son los campos que cambiaron, siendo lo que eran a lo que cambiaron.
HireHop no esperará una respuesta de la URL llamada ni informará un error HTTP al llamarlo.
Ejemplo de código PHP para un punto final de URL para capturar los datos del webhook sería:
<?php // Leer los datos JSON $postdata = file_get_contents('php://input'); // Convertir datos JSON en un objeto $data_str = json_decode($postdata); ?>