Conta e Instâncias
Configurar Webhook
Define ou atualiza a URL de webhook da instância. A URL deve ser pública e acessível via HTTPS. Eventos como mensagens recebidas, status de entrega e mudanças de conexão serão enviados via POST para essa URL. ⚠️ ATENÇÃO À URL: o {id} já vai no caminho: NÃO adicione duas vezes. ✅ Certo: PUT /api/v1/instances/SEU-INSTANCE-ID/webhook ❌ Errado: PUT /api/v1/SEU-INSTANCE-ID/instances/SEU-INSTANCE-ID/webhook (instanceId duplicado)
https://api.zapzapapi.com/api/v1/instances/{id}/webhookAutenticação por cabeçalhos x-api-key e x-api-secret.
Parâmetros
| Nome | Tipo | Onde | Obrigatório | Descrição |
|---|---|---|---|---|
id | text | caminho | Sim | ID da instância |
webhook_url | text | corpo | Sim | URL do webhook (HTTPS) |
events | text | corpo | Não | Eventos para receber (vazio = todos) |
excludeMessages | select | corpo | Não | Excluir mensagens próprias |
Exemplo de requisição
curl
curl -X PUT "https://api.zapzapapi.com/api/v1/instances/{id}/webhook" \
-H "x-api-key: SUA_API_KEY" \
-H "x-api-secret: SEU_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"webhook_url":"https://meusite.com/webhook"}'Node.js
const res = await fetch("https://api.zapzapapi.com/api/v1/instances/{id}/webhook", {
method: "PUT",
headers: {
"x-api-key": "SUA_API_KEY",
"x-api-secret": "SEU_API_SECRET",
"Content-Type": "application/json",
},
body: JSON.stringify({
"webhook_url": "https://meusite.com/webhook"
}),
});
console.log(await res.json());Python
import requests
res = requests.put(
"https://api.zapzapapi.com/api/v1/instances/{id}/webhook",
headers={"x-api-key": "SUA_API_KEY", "x-api-secret": "SEU_API_SECRET"},
json={"webhook_url":"https://meusite.com/webhook"},
)
print(res.json())Exemplo de resposta
JSON
{
"ok": true,
"webhook_url": "https://meusite.com/webhook"
}Os valores são ilustrativos; os campos seguem o formato real da resposta.
Outros endpoints desta categoria
Pegue suas chaves de API
Crie sua conta, conecte um número em minutos e comece a usar a API. R$15 por número ativo/mês, com crédito de boas-vindas ao criar a conta, sujeito à campanha vigente.