Cuenta e Instancias
Configurar Webhook
Define o actualiza la URL de webhook de la instancia. La URL debe ser pública y accesible por HTTPS. Eventos como mensajes recibidos, estado de entrega y cambios de conexión se enviarán por POST a esa URL. ⚠️ ATENCIÓN A LA URL: el {id} ya va en la ruta: NO lo agregues dos veces. ✅ Correcto: PUT /api/v1/instances/TU-INSTANCE-ID/webhook ❌ Incorrecto: PUT /api/v1/TU-INSTANCE-ID/instances/TU-INSTANCE-ID/webhook (instanceId duplicado)
https://api.zapzapapi.com/api/v1/instances/{id}/webhookAutenticación con los encabezados x-api-key y x-api-secret.
Parámetros
| Nombre | Tipo | Dónde | Obligatorio | Descripción |
|---|---|---|---|---|
id | text | ruta | Sí | ID de la instancia |
webhook_url | text | cuerpo | Sí | URL del webhook (HTTPS) |
events | text | cuerpo | No | Eventos a recibir (vacío = todos) |
excludeMessages | select | cuerpo | No | Excluir mensajes propios |
Ejemplo de solicitud
curl
curl -X PUT "https://api.zapzapapi.com/api/v1/instances/{id}/webhook" \
-H "x-api-key: TU_API_KEY" \
-H "x-api-secret: TU_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": "TU_API_KEY",
"x-api-secret": "TU_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": "TU_API_KEY", "x-api-secret": "TU_API_SECRET"},
json={"webhook_url":"https://meusite.com/webhook"},
)
print(res.json())Ejemplo de respuesta
JSON
{
"ok": true,
"webhook_url": "https://meusite.com/webhook"
}Los valores son ilustrativos; los campos siguen el formato real de la respuesta.
Otros endpoints de esta categoría
Consigue tus claves de API
Crea tu cuenta, conecta un número en minutos y empieza a usar la API. R$15 por número activo/mes, con un crédito de bienvenida al crear la cuenta, sujeto a la campaña vigente.