Dicionário de Eventos e Payloads de Webhook

Todos os webhooks disparados pelo Yzex Connect seguem a estrutura padrão com metadados de rastreamento e payload contextual.

Schema Base do Envelope

{
  "event_id": "evt_01J7KXYZ1234567890ABCDEF",
  "event_type": "message.received",
  "timestamp": 1725960000,
  "data": {
    "instance_name": "atendimento-principal",
    "remote_jid": "5511999998888@s.whatsapp.net",
    "message_id": "msg_01J7KABC...",
    "content": "Olá, gostaria de confirmar o pedido 1234.",
    "status": "delivered"
  }
}

Tópicos de Eventos Disponíveis

Tópico Descrição

instance.status_changed

Mudança de conectividade (connecting, open, close).

message.received

Mensagem de texto ou mídia recebida de contato externo.

message.delivery_updated

Atualização de status de entrega (sent, delivered, read).