Crear Webhook

Descripción

Los webhooks permiten que EVO notifique a sistemas externos cada vez que ocurre un evento específico. Esto posibilita integrar otros sistemas con EVO y automatizar acciones basadas en los eventos capturados.

OBS.: Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.
🚧 El webhook no se crea automáticamente para todas las sucursales, incluso utilizando una clave de ADM General. Para configurar el webhook en varias unidades, realiza el registro individualmente para cada sucursal, informando el idBranch correspondiente.

📨 Cuerpo de la Solicitud (Request Body)

Parámetro	Tipo	Descripción
`idBranch`	String	Número de la sucursal donde se registrará el webhook. Solo disponible al usar una clave multilocal, ignorado de lo contrario.
`eventType`	String	Especifica el tipo de evento que activará este webhook.
`urlCallback`	String	URL que será llamada después de que ocurra el evento. La API receptora debe aceptar POST con el contenido en el formato especificado.
`headers`	Arrayobject	Opcional. Lista de encabezados personalizados incluidos en la solicitud. Cada encabezado es un objeto con `name` (string) y `value` (string).
`filters`	Arrayobject	Opcional. Lista de filtros aplicables solo para webhooks de tipo `NewSale`. Ver explicación abajo.

🧩 Estructura del Objeto `filters`

Cada filtro debe ser un objeto con los campos:

Parámetro	Tipo	Descripción
`filterType`	string	Tipo de filtro a aplicar. Actualmente disponible: `SaleItemDescription`.
`value`	string	Valor usado para filtrar. La coincidencia se realiza por contiene (substring).

📄 Reglas para múltiples filtros

Si se configuran varios filtros, la validación se realiza como condición OR. Ejemplo:

"filters": [
  { "FilterType": "SaleItemDescription", "Value": "ANUAL" },
  { "FilterType": "SaleItemDescription", "Value": "MENSAL" }
]

El webhook se activará siempre que la descripción del ítem de venta contenga "ANUAL" o "MENSUAL".

📤🪝 Payload recibido tras el disparo del Webhook

Cuando ocurre un evento configurado, EVO realizará una solicitud HTTP POST a la urlCallback registrada, enviando un objeto estándar con la notificación del evento:

Campo	Tipo	Descripción
`IdW12`	int32	Identificador de la cuenta W12 (empresa) donde ocurrió el evento.
`IdBranch`	int32	Identificador de la sucursal asociada al evento.
`IdRecord`	int32	Identificador del registro generado por el evento (ej.: ID de venta, matrícula, cliente, etc.).
`EventType`	string	Tipo de evento que disparó el webhook (ej.: `NewSale`).
`ApiCallback`	string	Endpoint de la API de integración EVO para consultar los datos completos del evento ocurrido.

📝 Ejemplo de Payload

{
  "IdW12": 123,
  "IdBranch": 1,
  "IdRecord": 123,
  "EventType": "NewSale",
  "ApiCallback": "https://evo-integracao-api.w12app.com.br/api/v1/sales/123"
}

El formato del objeto es el mismo para todos los eventos. Las únicas variaciones son:

EventType: nombre del evento disparado.

ApiCallback: cada tipo de evento tiene un endpoint específico para consulta detallada en la API de Integración.

Eventos Disponibles

🏋️ Actividades y Accesos

`eventType`	Descripción	ID Recibido
EndedSessionActivity	Se activa cuando se finaliza una sesión de la agenda.	`idActivitySession`
Entries	Se activa cuando se registra un ingreso en control de acceso.	`IdEntry`
ActivityEnroll	Se activa cuando un alumno se agenda para una actividad de la agenda.	`idSession`
SpotAvailable	Se activa cuando una actividad previamente llena obtiene un cupo disponible.	`idActivitySession`
AppointmentEnroll	Se activa cuando se genera un nuevo agendamiento de actividad (EVO, Sitio/Totem/Fiti/API).	`idActivitySession`
CancelAppointment	Se activa cuando se cancela un agendamiento de actividad (EVO, Sitio/Totem/Fiti/API).	`idActivitySession`
EndedSessionAppointment	Se activa cuando se finaliza la actividad de agenda en EVO (manual o vía cron job).	`idActivitySession`

👤 Clientes (Miembros)

`eventType`	Descripción	ID Recibido
CreateMember	Se activa cuando una oportunidad se convierte en cliente.	`idMember`
AlterMember	Se activa cuando se modifica información personal o se elimina un cliente. Nota: No incluye cambios de activo a inactivo.	`idMember`
Freeze	Se activa cuando se suspende o retira la suspensión de un alumno.	`idMemberMembership`
TransferMember	Se activa cuando un cliente se transfiere de una sucursal a otra.	`idMember`

📄 Contratos (Membership y MemberMembership)

`eventType`	Descripción	ID Recibido
CreateMembership	Se activa cuando se crea un nuevo tipo de contrato.	`idMembership`
AlterMembership	Se activa cuando se modifica información de un contrato.	`idMembership`
ScheduleCancelMembership	Se activa cuando se programa la cancelación de un contrato.	`idMemberMembership`
CancelMembership	Se activa cuando se cancela un contrato.	`idMemberMembership`

💳 Finanzas

`eventType`	Descripción	ID Recibido
ClearedDebt	Se activa cuando un cliente paga un saldo vencido (posterior a la fecha de vencimiento).	`idSale`
AlterReceivables	Se activa al editar manualmente información de cuentas por cobrar. Cambios automáticos no disparan el evento.	`idReceivable`
NewInvoice	Se activa cuando se emite una nueva factura.	`id`
CancelInvoice	Se activa cuando se cancela una factura emitida.	`id`

🎯 Oportunidades (Prospects)

`eventType`	Descripción	ID Recibido
TransferProspect	Se activa cuando un prospect se transfiere a otra sucursal.	`idProspect`

📦 Productos

`eventType`	Descripción	ID Recibido
CreateProduct	Se activa al crear un nuevo producto.	`id`
AlterProduct	Se activa al modificar un producto.	`id`

🛠️ Servicios

`eventType`	Descripción	ID Recibido
CreateService	Se activa al crear un nuevo servicio.	`idService`
AlterService	Se activa al modificar un servicio.	`idService`

🛒 Ventas

`eventType`	Descripción	ID Recibido
NewSale	Se activa cuando se realiza una nueva venta en EVO o Sitio/Totem. Nota: No incluye ventas generadas automáticamente por recurrencia.	`idSale`
RecurrentSale	Se activa cuando un contrato se renueva automáticamente.	`idSale`
SalesItensUpdated	Se activa cuando se agrega un nuevo ítem de venta en una Página de Ventas.	`idSaleItem`

Solicitud

Autorización

Envía tus solicitudes HTTP con un encabezado

Authorization

que contenga la palabra Basic seguida de un espacio y una cadena codificada en base64 username:password

Ejemplo:

Authorization: Basic *****************

Parámetros del Body

application/json-patch+json

Ejemplo

{
    "idBranch": 0,
    "eventType": "string",
    "urlCallback": "string",
    "headers": [
        {
            "nome": "string",
            "valor": "string"
        }
    ],
    "filters": [
        {
            "filterType": "string",
            "value": "string"
        }
    ]
}

Ejemplos de solicitud

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add new webhook

Crear Webhook

Descripción

📨 Cuerpo de la Solicitud (Request Body)

🧩 Estructura del Objeto `filters`

📄 Reglas para múltiples filtros

📤🪝 Payload recibido tras el disparo del Webhook

📝 Ejemplo de Payload

Eventos Disponibles

🏋️ Actividades y Accesos

👤 Clientes (Miembros)

📄 Contratos (Membership y MemberMembership)

💳 Finanzas

🎯 Oportunidades (Prospects)

📦 Productos

🛠️ Servicios

🛒 Ventas

Solicitud

Ejemplos de solicitud

Respuestas

Add new webhook

Crear Webhook#

Descripción#

📨 Cuerpo de la Solicitud (Request Body)#

🧩 Estructura del Objeto filters#

📄 Reglas para múltiples filtros#

📤🪝 Payload recibido tras el disparo del Webhook#

📝 Ejemplo de Payload#

Eventos Disponibles#

🏋️ Actividades y Accesos#

👤 Clientes (Miembros)#

📄 Contratos (Membership y MemberMembership)#

💳 Finanzas#

🎯 Oportunidades (Prospects)#

📦 Productos#

🛠️ Servicios#

🛒 Ventas#

Solicitud

Ejemplos de solicitud

Respuestas

Crear Webhook

Descripción

📨 Cuerpo de la Solicitud (Request Body)

🧩 Estructura del Objeto `filters`

📄 Reglas para múltiples filtros

📤🪝 Payload recibido tras el disparo del Webhook

📝 Ejemplo de Payload

Eventos Disponibles

🏋️ Actividades y Accesos

👤 Clientes (Miembros)

📄 Contratos (Membership y MemberMembership)

💳 Finanzas

🎯 Oportunidades (Prospects)

📦 Productos

🛠️ Servicios

🛒 Ventas