Cómo usar webhooks

Los webhooks de EVO permiten que el sistema notifique a otros sistemas siempre que ocurra un evento específico, facilitando la automatización de procesos y la integración entre plataformas. A continuación se presenta el paso a paso para crear un webhook en EVO.

¿Qué es un Webhook?

Un webhook es un mecanismo de notificación en tiempo real, donde el sistema EVO envía información a una URL externa cada vez que ocurre un evento específico (como una venta realizada, un cliente registrado, etc.).
Leer más.

Paso 1: Obtener la URL de callback

El primer paso para configurar un webhook es tener una URL de callback. Esta URL será el punto de recepción de los datos enviados por EVO.

¿Qué es la URL de callback?

Es la URL de un servidor o API externa que estará preparada para recibir solicitudes POST con los datos del evento.

Es obligatorio que utilice el protocolo HTTPS.

Un sitio que puede utilizarse para realizar pruebas es
https://webhook.site/, registrando un webhook con la URL disponible en el sitio.

Paso 2: Elegir el tipo de evento

Seleccione el tipo de evento que activará el webhook.

EVO ofrece varios tipos de eventos, como NewSale, CreateMember, AlterMember, entre otros. Los eventos disponibles y la descripción de cada uno se encuentran en el endpoint de
agregar nuevo webhook.

Ejemplos de eventos:

NewSale: Se dispara cuando se realiza una venta.

CreateMember: Se dispara cuando una oportunidad se convierte en cliente.

NewInvoice: Se dispara cada vez que se genera una nueva factura en el sistema.

Paso 3: Determinar los parámetros necesarios

Al configurar el webhook, debe completar algunos parámetros obligatorios y, opcionalmente, parámetros adicionales.

Parámetros obligatorios

eventType: Tipo de evento que activará el webhook (ej.: NewSale).

urlCallback: La URL externa que recibirá los datos del evento.

Parámetros opcionales

idBranch: Número de la sucursal donde ocurrió el evento (si se utiliza multi-sucursal).

headers: Encabezados personalizados, como un token de autenticación.

filters: Filtros aplicables (por ejemplo, filtrar solo ventas de un producto específico).

Paso 4: Enviar una solicitud POST

Para registrar el webhook en EVO, envíe una solicitud POST con los parámetros definidos. Puede utilizar nuestra documentación para hacerlo.

Ejemplo de estructura JSON para el webhook

{
   "IdBranch": "1", 
   "eventType": "NewSale", 
   "urlCallback": "https://meusistema.com/webhook/callback", 
   "headers": [
        {"name": "Authorization", "value": "Bearer token"}
    ],
   "filters": [
        {
            "FilterType": "SaleItemDescription", 
            "Value": "Produto A"
        }
    ]
}

Cómo usar webhooks

¿Qué es un Webhook?#

Paso 1: Obtener la URL de callback#

Paso 2: Elegir el tipo de evento#

Paso 3: Determinar los parámetros necesarios#

Parámetros obligatorios#

Parámetros opcionales#

Paso 4: Enviar una solicitud POST#

Ejemplo de estructura JSON para el webhook#