ZapyFlow/Documentación de la APIopenapi.json

Catálogo de eventos

28 eventos. Cada uno alimenta tanto los webhooks salientes como los disparadores de las integraciones nativas — es la misma lista, porque responde a la misma pregunta.

Todo evento de aquí tiene un emisor verificado en el servidor, comprobado por una prueba que recorre el código. Esa prueba existe por un defecto real: bot.created se ofrecía en el panel y no disparaba desde hacía meses, porque el código había renombrado el concepto y el catálogo se quedó quieto. Quien lo tenía suscrito esperaba entregas que no podían llegar, sin error en ninguna parte.

Conversaciones

Mensajes que entran y salen, estado de entrega, y el ciclo de vida de una conversación.

EventoObservación
message.received
message.sent
message.status
conversation.created
conversation.status.changed
conversation.resolved
conversation.escalated

Comercial

Todo lo que el agente de IA captura o agenda en tu nombre.

EventoObservación
lead.captured
order.created
order.updated
order.deleted
appointment.created
appointment.updated
appointment.deleted
crm.card.created
crm.card.moved
crm.card.updated
crm.card.deleted

Plataforma

Agentes, canales de WhatsApp y sincronización de catálogo.

EventoObservación
bot.createdSe emite internamente como ai-agent.created. El nombre público es el contrato y no cambia cuando renombramos cosas por dentro.
bot.deletedSe emite internamente como ai-agent.deleted. El nombre público es el contrato y no cambia cuando renombramos cosas por dentro.
channel.connected
catalog.synced

Cobros y cuota

Umbrales de uso y eventos de suscripción.

EventoObservación
quota.warning
quota.exceeded
trial.started
trial.locked
payment.succeeded
payment.failed

Forma del payload

Toda entrega lleva el mismo sobre: id (el id estable del evento, también en la cabecera X-ZapyFlow-Event-Id), event (el nombre de esta tabla) y data (el objeto propio de ese evento). Trata data como abierto — añadimos campos sin avisar.

Lo que queda fuera a propósito

Señales de interfaz en tiempo real — indicador de escritura, presencia, cambio de foto de perfil — viven en el bus interno y no se ofrecen aquí. Disparan constantemente, no llevan significado de negocio, y suscribirse a ellas te costaría una entrega por tecla pulsada.