Pular para o conteúdo principal
Use $vzaps->webhooks() para receber eventos da VZaps via HTTP callback na sua aplicação. Campos comuns em todas as chamadas:
CampoTipoObrigatórioDescrição
instanceIdstringSimID da instância.
instanceTokenstringSimToken da instância.

​
webhooks()->get($instanceId, $instanceToken = null)

Lê a configuração atual do webhook. 
$webhook = $vzaps->webhooks()->get('VZ...', 'instance-token');

print_r($webhook);
Retorno: envelope { code, success, data } com webhook e subscribe (eventos).

​
webhooks()->set($request)

Define URL e eventos assinados. 
$vzaps->webhooks()->set([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'webhookURL' => 'https://example.com/webhooks/vzaps',
    'events' => ['Message', 'ReadReceipt', 'Connected', 'Disconnected'],
]);
Retorno: envelope { code, success, data } com webhook e events configurados.
CampoTipoObrigatórioDescrição
webhookURLstringSimURL pública que receberá os callbacks.
eventsstring[] ou stringNãoEventos assinados.
Eventos comuns: Message, ReadReceipt, Connected, Disconnected, Presence, ChatPresence, HistorySync, GroupParticipantsAdd, GroupParticipantsRemove, All.

​
webhooks()->searchLogs($request)

Busca logs de entrega do webhook. 
$logs = $vzaps->webhooks()->searchLogs([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'status' => 'failed',
]);

print_r($logs);
Retorno: envelope { code, success, data } com pagina de logs (content[], totais).

​
webhooks()->getLog($request)

Lê um log específico de entrega. 
$log = $vzaps->webhooks()->getLog([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'logId' => 'log_123',
]);

print_r($log);
Retorno: envelope { code, success, data } com um log de entrega (status, payload, tentativas, etc.).

​
webhooks()->retryLog($request)

Reenvia uma entrega com falha. 
$vzaps->webhooks()->retryLog([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'logId' => 'log_123',
]);
Retorno: envelope { code, success, data } confirmando reenvio do callback.

​
Quando usar webhook

Use webhook quando:
  • sua aplicação já possui URL pública para receber callbacks;
  • você quer processar eventos de forma assíncrona no backend;
  • seu pipeline de integração já trabalha com HTTP POST.
Para bots, dashboards e apps que precisam de baixa latência sem expor URL, prefira Realtime.