Skip to main content
POST
https://api.enviaai.app
/
v1
/
webhooks
Criar Webhook
curl --request POST \
  --url https://api.enviaai.app/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "instanceId": "<string>",
  "events": [
    {}
  ],
  "name": "<string>",
  "secret": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "wh_xyz789",
    "name": "Webhook Principal",
    "url": "https://myapp.com/webhooks/enviaai",
    "instanceId": "inst_abc123",
    "events": ["message.received", "message.sent", "message.delivered"],
    "secret": "whs_abc123...",
    "status": "active",
    "createdAt": "2026-02-03T12:00:00.000Z"
  }
}

​
Request Body

​
url
string
required
URL do endpoint que receberá os eventos
​
instanceId
string
required
ID da instância vinculada
​
events
array
required
Lista de eventos para receber
​
name
string
Nome descritivo do webhook
​
secret
string
Secret para verificação de assinatura (gerado se não informado)

​
Eventos Disponíveis

  • message.received - Mensagem recebida
  • message.sent - Mensagem enviada
  • message.delivered - Mensagem entregue
  • message.read - Mensagem lida
  • message.failed - Falha no envio
  • instance.connected - Instância conectou
  • instance.disconnected - Instância desconectou
  • instance.qr_updated - QR Code atualizado

​
Exemplo

const webhook = await client.webhooks.create({
  name: 'Webhook Principal',
  url: 'https://myapp.com/webhooks/enviaai',
  instanceId: 'inst_abc123',
  events: [
    'message.received',
    'message.sent',
    'message.delivered'
  ]
});

console.log('Webhook criado:', webhook.id);
console.log('Secret:', webhook.secret);

{
  "success": true,
  "data": {
    "id": "wh_xyz789",
    "name": "Webhook Principal",
    "url": "https://myapp.com/webhooks/enviaai",
    "instanceId": "inst_abc123",
    "events": ["message.received", "message.sent", "message.delivered"],
    "secret": "whs_abc123...",
    "status": "active",
    "createdAt": "2026-02-03T12:00:00.000Z"
  }
}
Guarde o secret em local seguro. Ele é mostrado apenas na criação.

​
Erros

CódigoDescrição
invalid_urlURL não é válida ou não usa HTTPS
instance_not_foundInstância não existe
invalid_eventsEventos inválidos