Webhooks

Consulte os principais Webhooks que enviamos sempre que recebemos algum evento em sua conta.

Através do Webhook você consegue saber por exemplo sempre que receber uma mensagem ou uma chamada.

Você pode configurar a mesma URL para todos os nossos Webhooks (se preferir). Enviamos no header 2 parâmetros chamados hook e apiKey para ajudar você identificar de qual Webhook e conta se trata o evento.

Todos os Webhooks são enviados via POST com Content-Type: application/json.

• onSender = Para confirmação de envio de mensagens.
• onAck = Para confirmação de status de mensagens enviadas.
• onReceived = Para mensagens recebidas.
• onChangeGroup = Enviado sempre que houver mudanças na configuração de algum grupo que você participa.
• onLiveLocation = Enviado sempre que houver atualização de localização em tempo real (Live Location).
• onIncomingCall = Enviado sempre que receber uma ligação de áudio ou vídeo.
• onStateChanged = Enviado sempre que houver uma alteração no status da conexão.
• onQrcode = Enviado sempre que for necessário realizar uma leitura do QR Code para conexão.
• onParticipantsChanged = Enviado sempre que você sair de um grupo, um membro for removido, incluído, promovido ou despromovido a admin.
• onAddedToGroup = Enviado sempre que você for incluído ou criar um grupo.

Regras do Webhook (importante)
Para considerarmos o evento entregue, seu endpoint deve responder com HTTP 200 ou 202 em até 3 segundos. Não é necessário retornar conteúdo no body.

Se ocorrer timeout (3s) ou HTTP diferente de 200/202, iremos considerar como falha e reenviar o mesmo evento (até 3 tentativas no total).
Por isso, seu endpoint deve ser idempotente: você pode receber o mesmo evento mais de uma vez.
Se necessário, implemente um lock/controle de duplicidade no seu servidor (ex.: guardar por algumas horas um identificador do evento + hook e ignorar repetições).

Para receber os webhooks, você também precisa gerar a API Key, mesmo que não vá fazer consultas nos endpoints da api.

Header do request (comum)