Skip to main content

Introdução

Introdução ao Webhook​

Conceito​

Neste tópico, vamos discutir os RETORNOS dos webhooks que nossa API oferece.

As instâncias da nossa API enviam requisições com o método POST sobre os eventos realizados por ela para a URL previamente configurada. Cada requisição tem um corpo em JSON específico, que será detalhado a seguir.

Importante​

O seu endpoint precisa aceitar um POST. Esses endpoints são essenciais para alterar a URL que a instância vai chamar quando o evento acontecer.

O que é e Para que Serve?​

Segundo o Google, Webhook é um meio usado na web para que uma aplicação forneça informações a outra, entregando dados em tempo real sempre que um evento acontecer. Assim, dois sistemas podem trocar informações sem necessidade de uma ação externa.

Portanto, se você está se integrando com nossa API e precisa receber informações pelo WhatsApp, é necessário disponibilizar estes end-points na sua aplicação para conseguirmos notificar sobre tudo que acontece no seu WhatsApp. Dessa forma, sempre que o número conectado receber uma interação, vamos fazer uma requisição com o método POST para a URL configurada previamente.

Nossos Webhooks​

Aqui estão os webhooks que fornecemos:

  • QRCODE_UPDATED: Envia o base64 do QRCode para leitura.
  • CONNECTION_UPDATE: Informa o status da conexão com o WhatsApp.
  • MESSAGES_SET: Envia uma lista de todas as suas mensagens carregadas no WhatsApp. Esse evento ocorre apenas uma vez.
  • MESSAGES_UPSERT: Notifica você quando uma mensagem é recebida.
  • MESSAGES_UPDATE: Informa você quando uma mensagem é atualizada.
  • SEND_MESSAGE: Notifica quando uma mensagem é enviada.
  • CONTACTS_SET: Realiza o carregamento inicial de todos os contatos. Este evento ocorre só uma vez.
  • CONTACTS_UPSERT: Recarrega todos os contatos com informações adicionais. Este evento ocorre só uma vez.
  • CONTACTS_UPDATE: Informa você quando o chat é atualizado.
  • PRESENCE_UPDATE: Informa se o usuário está online, se ele está realizando alguma ação como escrever ou gravar e sua última visualização.
  • CHATS_SET: Envia uma lista de todos os chats carregados.
  • CHATS_UPDATE: Informa você quando o chat é atualizado.
  • CHATS_UPSERT: Envia qualquer nova informação de chat.
  • GROUPS_UPSERT: Notifica quando um grupo é criado.
  • GROUPS_UPDATE: Notifica quando um grupo tem suas informações atualizadas.
  • GROUP_PARTICIPANTS_UPDATE: Notifica quando ocorre uma ação envolvendo um participante do grupo.
  • NEW_TOKEN: Notifica quando o token (jwt) é atualizado.

Dica​

Não deixe de ler nossa seção de dicas, onde você vai encontrar alguns tópicos de como melhorar sua conexão com nossa API e ter mais qualidade no serviço.

Importante​

Nunca compartilhe seu ID e token com ninguém.

Como Configurar meu Webhook?​

Pode-se atualizar o webhook de uma instância por dois caminhos diferentes: Via painel, onde você acessa nosso painel administrativo, em Instâncias clique em "visualizar" na instância que deseja e nos 3 pontinhos escolha "editar".

Lembrando que, quanto mais controle você possuir sobre sua instância, mais vai conseguir extrair recursos e desenvolver negócios com nossa API.