Skip to main content

Qué es

Este catálogo cubre los 47 tipos de eventos de webhook en la especificación OpenAPI y conserva cada ejemplo de payload con nombre.

Cómo funciona

Elige un evento por su type exacto, despliega un ejemplo y usa el payload para probar el enrutamiento, la deserialización, la idempotencia y el procesamiento asíncrono en tu receptor de webhooks.

Solicitud

Cada ejemplo es el cuerpo JSON de una solicitud HTTP POST enviada por YCloud. La solicitud también incluye un encabezado YCloud-Signature que debes validar antes de confiar en el payload.

Respuesta

Devuelve una respuesta 2xx una vez que tu aplicación haya aceptado el evento de forma duradera.
Para conocer los desencadenadores de eventos, los campos de los payloads y ver ejemplos, consulta Ejemplos de Webhook.

Catálogo de payloads

Usa messengerInboundMessage.id para correlacionar mensajes repetidos de clientes; conserva los espacios en blanco del texto.
El mismo mensaje guardado ahora incluye el texto más reciente y los datos acumulados de la edición.
Usa el ID de mensaje para correlacionar instantáneas; se omiten las marcas de tiempo intermedias de entrega desconocidas.
El mensaje de Meta de destino no necesita tener un registro de mensaje local en YCloud.
Las eliminaciones de reacciones pueden omitir el nombre de la reacción y el emoji.
Guarda el texto de whatsappMessage.text.body. id y wamid vinculan eventos de estado posteriores.
El contenido del mensaje varía según el tipo. Trata los ID de archivos multimedia como referencias del proveedor, no como URL públicas de descarga.
Correlaciona con el evento creado mediante id o wamid. Los eventos actualizados omiten el contenido y el tipo del mensaje.
Correlaciona con el evento creado mediante id o wamid. Los eventos actualizados omiten el contenido y el tipo del mensaje.
Puede llegar un estado de origen de menor prioridad después de read. Registra el evento sin degradar el estado actual de tu mensaje.
Este es un mensaje fallido independiente, no una transición desde read. Las actualizaciones fallidas incluyen detalles del error de origen cuando están disponibles.
APP_CONTROL_TAKEN notifica la transferencia de control, no una asignación de empleado en Inbox ni la entrega de un mensaje personalizado de traspaso. En este ejemplo, actor es el ID de la aplicación propietaria anterior.
Lee whatsappBusinessAccount.id para identificar la cuenta. Cuando están presentes, removedReason, removedInitiatedBy y removedTime describen la eliminación. Conserva los valores desconocidos de motivo e iniciador.
Lee qualityRating y qualityUpdateEvent de whatsappPhoneNumber. messagingLimit describe el nivel del número de teléfono; whatsappBusinessManagerMessagingLimit describe el límite del portafolio comercial propietario.
Payload de ejemplo cuando se modifican los atributos de un contacto
Payload de ejemplo cuando se crea un nuevo contacto
Payload de ejemplo cuando se elimina un contacto
Se emite únicamente al eliminar una nota de forma independiente, no por eliminación en cascada de un contacto.
Payload de ejemplo cuando un cliente cancela la suscripción
Payload de ejemplo cuando un cliente reanuda la suscripción
Payload de ejemplo cuando se activa un nombre de usuario comercial de un número de teléfono de WhatsApp
Ejemplo de payload cuando un número de teléfono de WhatsApp tiene una solicitud de Business Username reservado
Meta detectó contenido de marketing en un mensaje de Utility Direct Send. Suscríbete a este evento a través de la API de webhook endpoint.
Meta restringió Utility Direct Send durante 7 días tras un uso indebido reiterado de categorías.
Ejemplo de payload cuando se archiva una plantilla de WhatsApp
Ejemplo de payload cuando se desarchiva una plantilla de WhatsApp. El estado de la plantilla es el estado actual devuelto por Meta y no representa una nueva revisión de aprobación.
Ejemplo de payload cuando se conecta una llamada de WhatsApp
Ejemplo de payload cuando finaliza una llamada de WhatsApp
Ejemplo de payload cuando se actualiza el estado de una llamada de WhatsApp
Ejemplo de payload cuando pasa a estar disponible una grabación de llamada originada por la API
Ejemplo de payload cuando falla de forma permanente una transcripción de llamada originada por la API
Ejemplo de payload cuando se crea un grupo de WhatsApp
Ejemplo de payload cuando se añaden participantes a un grupo de WhatsApp
Ejemplo de payload cuando se actualiza la configuración de un grupo de WhatsApp
Ejemplo de payload cuando cambia el estado de suspensión de un grupo de WhatsApp
Lee el mensaje saliente desde whatsappMessage. El tipo de mensaje selecciona su objeto de contenido; este ejemplo contiene texto.
Este evento sincroniza un mensaje enviado desde la app WhatsApp Business o un dispositivo complementario compatible. Lee su contenido desde whatsappMessage.
Un mensaje de historial entrante utiliza whatsappInboundMessage. phase y progress informan sobre la sincronización del fragmento de historial.
Un mensaje de historial saliente utiliza whatsappMessage. No lo enrutes como un mensaje entrante.
Un fragmento de historial solo con metadatos informa de phase y progress sin ninguno de los dos objetos de mensaje. No trates esta estructura como un payload de tipo message-created o message-echoes.