Introducción a los webhooks en OBUMA ERP
https://www.obuma.cl/ayuda/articulo/708¿Qué es un webhook?
Un webhook es un mecanismo que permite que OBUMA ERP notifique automáticamente a tu sistema cuando ocurre un evento (por ejemplo: creación de un cliente, actualización de un producto, creación de una cotización, etc.).
En lugar de que tu sistema esté consultando constantemente la API para verificar si hubo cambios, con los webhooks OBUMA envía la información de forma inmediata y automática apenas se produce el evento.
En pocas palabras:
-
Tu sistema registra una URL en OBUMA ERP.
Cuando ocurre un evento, OBUMA envía un JSON vía
POST
a tu URL.Dependiendo del evento, el JSON puede contener:
-
Información mínima (por ejemplo, solo el
id
de la cotización o cliente). En estos casos, tu sistema debe consultar la API REST con ese ID para obtener todos los detalles. -
Información completa (por ejemplo, en algunos eventos de creación/actualización de productos o clientes), donde el payload incluye todos los datos del recurso sin necesidad de hacer una petición adicional.
-
Ejemplo de información mínima
Evento: cotizacion.created
{
"cotizacion_id": 1016520
}
En este caso solo se envía el ID de la cotización.
Para obtener todos los detalles de la cotización, tu sistema debe consultar la API en:
GET /ventasCotizaciones.findById.json/1016520
Ejemplo de información completa
Evento: cliente.created
{
"cliente_id": "1012555",
"cliente_rut": "76.444.222-1",
"cliente_contacto": "ARTURO SOTO",
"cliente_razon_social": "EJEMPLO RAZON SOCIAL",
"cliente_nombre_fantasia": "EJEMPLO FANTASIA",
"cliente_email": "ejemplocliente@ejemplo.cl",
"cliente_direccion_facturacion": "DIRECCION EJEMPLO FACTURACION",
"cliente_comuna_facturacion": "46",
"cliente_region_facturacion": "13",
"cliente_activo": "1"
}
En este caso, el webhook ya entrega toda la información relevante del cliente directamente en el payload, sin necesidad de hacer una consulta extra a la API.