Vixiees API
Bienvenido a la API de Vixiees
La API de Vixiees te permite integrar de forma segura y eficiente tus sistemas con nuestra plataforma, automatizar procesos y sincronizar datos en tiempo real. Con una única X-API-Key, podrás crear y actualizar contactos y deals, acceder a grabaciones, enviar mensajes de WhatsApp mediante templates aprobados y recibir notificaciones instantáneas a través de webhooks configurables.
Diseñada para ser robusta, escalable y sencilla de implementar, la API ofrece endpoints predecibles, límites claros y soporte inteligente para desarrolladores.
Qué puedes hacer con la API
- Contactos: crear, actualizar y recibir cambios automáticamente.
- Deals: crear, actualizar y recibir cambios automáticamente.
- Grabaciones: consultar y recuperar grabaciones de llamadas.
- Mensajería: enviar plantillas de WhatsApp Business.
- Webhooks: recibir eventos en tiempo real de contactos y deals.
- Servidor MCP: conectar asistentes de IA como Claude a tu cuenta.
Acceso y autenticación
- Ve a Settings -> Account -> API.
- Habilita la API y copia tu X-API-Key secreta.
- (Opcional) Activa los webhooks y define la Webhook URL. La API Key es sensible - no la compartas públicamente.
Webhooks
- Activa o desactiva eventos específicos desde la misma sección.
- Define tu URL de recepción.
- Recibe notificaciones instantáneas cuando haya cambios importantes.
Servidor MCP (asistentes de IA)
Conecta asistentes de IA como Claude y ChatGPT a tu cuenta mediante el servidor MCP de Vixiees
(https://api.vixiees.com/mcp). Los pasos de configuración y la referencia completa están en developers.vixiees.com/es/mcp.
Límites de uso
- License-Based Scaling
- Por minuto:
licenses x 25 requests - Por hora: x60
- Por día: x24
- Por minuto:
- Hardcore limit: 40 requests / 2 s (independiente de otros límites).
- Si se excede algún límite, se devuelve
429 TooManyRequestscon detalles y enlace a developers.vixiees.com.
Paginación
- Máx. 100 registros por conjunto de páginas.
- Usa
limit <= 100ypage=1en adelante. - Filtra por
created_atoupdated_atpara segmentar resultados. Ejemplo:updated_at>=2025-08-07T00:00:00 422 Unprocessable Entityindica que se ha superado el límite o la query es inválida.
Resumen rápido
| Elemento | Detalle |
|---|---|
| Autenticación | X-API-Key desde Settings -> Account -> API |
| Webhooks | Configurables desde la misma sección |
| Rate Limits | License-Based + Hardcore (40 req/2s) |
| Paginación | Máx. 100 registros por conjunto de páginas |
| Servidor MCP | https://api.vixiees.com/mcp - ver la sección MCP |
| Funcionalidades principales | Contactos, deals, grabaciones, WhatsApp templates, eventos |
Casos de uso comunes
1. Sincronizar contactos a CRM externo
- GET
/contactscon filtroupdated_at_frompara sincronización incremental - Configura el webhook
contact_updatedpara actualizaciones en tiempo real; cuando un contacto entra en un paso del flujo el payload incluye tambiénaction: flow_step_changedychanges([anterior, nuevo]por campo)
2. Enviar WhatsApp después del envío de un formulario
- Configura el webhook
submitted_form_created - POST
/whatsapp_templates/{id}/send_messagepara enviar la confirmación
3. Seguimiento del pipeline de deals
- Configura el webhook
deal_createdpara enterarte de los deals nuevos creados desde Vixiees, la API pública o un workflow (los deals importados de HubSpot/Pipedrive no lo envían) - Configura el webhook
deal_updated; cuando un deal se gana, se pierde o se reabre mediante su operación dedicada el payload incluye tambiénaction(won,lost,reopened) ychanges.statuscomo[anterior, nuevo] - GET
/dealspara sincronizar el estado actual a tu herramienta de BI
4. Automatizar la creación de tareas
- POST
/taskspara crear tareas de seguimiento vía API - Configura el webhook
task_completedpara notificaciones
Respuestas de error
Todos los endpoints devuelven errores en este formato:
{
"error": "Mensaje de error",
"details": { /* errores por campo */ }
}
Códigos HTTP comunes:
400- Solicitud inválida (parámetros incorrectos)401- No autorizado (API key inválida)404- Recurso no encontrado422- Validación fallida429- Límite de peticiones excedido