Pular para o conteúdo principal
POST
/
instances
/
{id}
/
webhook
Configurar webhook
curl --request POST \
  --url https://api.vzaps.com/instances/{id}/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookURL": "https://cliente.exemplo.com/webhooks/whatsapp",
  "events": "Message,ReadReceipt,Connected,Disconnected"
}
'
{
  "code": 200,
  "success": true,
  "data": {
    "webhook": "https://cliente.exemplo.com/webhooks/vzaps",
    "events": "Message,ReadReceipt,Connected,Disconnected"
  }
}

​
Eventos do Webhook

No corpo do POST /instances/{id}/webhook, o campo opcional events e uma string com um ou mais nomes de tipo, separados por virgula (sem espacos entre os tokens), por exemplo Message,Connected,Disconnected. Os nomes devem coincidir exatamente com os da tabela abaixo (mesmos valores usados no aplicativo web). Qualquer outro valor e invalido. Em especial, nao use Receipt, MessageDelivered ou MessageRead.
ValorDescricao
AllTodos os tipos de evento do webhook
ConnectedWhatsApp pareado / sessão conectada
DisconnectedWhatsApp ou sessão desconectada
MessageMensagens recebidas e enviadas
ReadReceiptRecibos de entrega e leitura. O payload usa state para diferenciar Delivered, Read e ReadSelf.
PresenceAtualizações de presença
HistorySyncSincronização de histórico
ChatPresencePresença no chat (digitando, gravando, …)
GroupParticipantsAddParticipantes adicionados a um grupo
GroupParticipantsRemoveParticipantes removidos de um grupo
Se voce omitir events no corpo, a lista de eventos ja configurada na instancia nao e alterada; apenas a URL do webhook pode ser atualizada.
Para receber confirmacoes de entrega e leitura, inscreva a instancia em ReadReceipt. Nao existem eventos separados chamados MessageDelivered ou MessageRead; use o campo state do payload do webhook: Delivered indica entrega ao dispositivo do destinatario, Read indica leitura pelo destinatario e ReadSelf indica leitura pela propria conta conectada.
Use os paths documentados para cada operacao, como /instances/{id}/chat/send/text, /instances/{id}/chat/markread e /instances/{id}/chat/react.

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

​
id
string
obrigatório

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Corpo

application/json
​
webhookURL
string<uri>
obrigatório

URL HTTPS para onde os payloads do webhook serao enviados. Envie string vazia para limpar a configuracao.

​
events
string

Lista separada por virgulas dos tipos a inscrever. Valores aceitos exatamente: Message, ReadReceipt, Presence, HistorySync, ChatPresence, Connected, Disconnected, GroupParticipantsAdd, GroupParticipantsRemove, All. Para entregue/lido, use somente ReadReceipt; nao use Receipt, MessageDelivered ou MessageRead.

Exemplo:

"Message,ReadReceipt,Connected,Disconnected"

Resposta

200 - application/json

Webhook salvo

​
code
integer
obrigatório
​
success
boolean
obrigatório
​
data
object