Docs
Webhooks e eventos
Receba mensagens, status e eventos do WhatsApp em tempo real na sua URL, com metadata para rotear no seu sistema.
Configurar a URL
PUT /instances/{id}
curl -X PUT https://api.zapzapapi.com/api/v1/instances/{id} \
-H "Content-Type: application/json" \
-H "x-api-key: SUA_API_KEY" \
-H "x-api-secret: SEU_API_SECRET" \
-d '{"webhook_url":"https://meusite.com/webhook","metadata":{"cliente":"123"}}'Receber os eventos
Cada mensagem recebida ou mudança de status chega como um POST na sua URL. Responda 2xx rápido:
Node.js (Express)
// Handler mínimo em Node.js (Express)
app.post("/webhook", (req, res) => {
res.sendStatus(200); // responda 2xx rápido
const evento = req.body; // mensagem recebida, status, etc.
// processe fora do caminho da resposta (fila, worker, etc.)
});Perguntas frequentes
Como receber mensagens do WhatsApp via webhook?
Configure a webhook_url da instância com um PUT em /api/v1/instances/{id}. A partir daí, cada mensagem recebida, status de entrega e evento chega como um POST na sua URL, em HTTPS.
O que é o metadata do webhook?
É um JSON livre que você associa à instância (por exemplo o ID do cliente ou o plano). Ele é incluído automaticamente nos webhooks recebidos, o que facilita rotear o evento no seu sistema.
Como devo responder ao webhook?
Responda 2xx o mais rápido possível e faça o trabalho pesado fora do caminho da resposta (fila ou worker). Um webhook que demora muito a responder é tratado como problemático.
Preciso de HTTPS?
Sim. A webhook_url deve ser HTTPS e acessível pela internet para o ZapZap conseguir entregar os eventos.
Comece com crédito grátis
Crie sua conta, conecte um número em minutos e teste a API com aquecimento e anti-bloqueio. R$15 por número ativo/mês, pré-pago, sem fidelidade.