Cómo funcionan los webhooks en HireHop

HireHop puede enviar un mensaje con datos a otras aplicaciones cuando se activan determinados eventos dentro de HireHop. Este mensaje se denomina webhook, y envía automáticamente los datos relevantes a la ubicación requerida.

¿Qué es un webhook?

Un webhook envía/impulsa un mensaje, con datos adjuntos al mensaje, cuando ocurren cosas específicas en HireHop (un evento). Los webhooks se envían a través de HTTP (llama 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 cual es mucho más eficiente y rápido que consultar periódicamente para detectar cambios en los datos.

Los webhooks de HireHop se pueden utilizar para comunicarse directamente con otras aplicaciones o enviarse a un conector como Zapier, que puede configurarse para formatear los datos y realizar cualquier llamada API necesaria de regreso a HireHop o a otra aplicación.

Configuración de un webhook

En HireHop, ve a Ajustes, luego haz clic en la pestaña Configuración de la empresa, y después en el botón Webhooks en la parte superior de la página. En la ventana emergente, haz clic en el botón Nuevo y añade la URL a la que se debe enviar el mensaje del webhook, y selecciona cada webhook al que quieras que responda la URL. Puedes añadir tantos webhooks como desees, pero debes limitarlos únicamente a los necesarios a los que responda esa URL específica.

Un webhook de HireHop enviará datos mediante POST a tu endpoint de URL en formato JSON, y contendrá datos similares o iguales a los siguientes:

{
    "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": "old",
            "to": "new"
        }, ...
    }
}

En el ejemplo JSON anterior, los siguientes campos son:

  • “hora” es la fecha y hora UTC en que se envió el webhook.
  • “user_id” es el ID del usuario que provocó que se activara el evento.
  • “user_name” es el nombre de su usuario.
  • “company_id” campo es el número de identificación ú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 comprobación de seguridad.
  • “evento” es el nombre del evento de webhook que se ha activado.
  • “datos” son los datos que corresponden al evento de webhook.
  • “cambios” son los campos que han cambiado, mostrando su valor anterior y su nuevo valor.

HireHop no esperará una respuesta de la URL llamada ni informará de un error HTTP al llamarla.

Un ejemplo de código PHP para un endpoint de URL que capture los datos del webhook sería:

<?php
	// Read the JSON data
	$postdata = file_get_contents('php://input');
	// Convert JSON data to an object
	$data_str = json_decode($postdata);
?>