Guia de Integração com Webhook Personalizado

Apenas usuários do plano Custom podem integrar com o Webhook. Se você estiver interessado na integração com Webhook, entre em contato com a equipe de vendas da Cooby.

Neste guia, você conectará o WhatsApp ao seu destino usando Webhooks personalizados do Cooby.

Você pode usar o mesmo Webhook para dois tipos de gatilhos de eventos diferentes ou configurar Webhooks separados para cada tipo de evento.

Guia de Configuração

Este guia utiliza webhook.site como exemplo

Acesse o Centro de Integração do seu workspace
Encontre "Webhook Personalizado" e clique em "Guia de Integração".


Crie um endpoint de Webhook no seu destino desejado.
Lembre-se de marcar a opção "CORS Headers".



Cole a URL do Webhook no campo "Acionar ações ao receber mensagens do WhatsApp" no guia de integração do Cooby e clique em "Salvar".
Se você deseja acionar uma ação ao enviar uma mensagem no WhatsApp, cole a URL do seu Webhook no campo "Acionar ações ao enviar mensagens do WhatsApp".


Verifique se a URL do Webhook foi salva, indicando que a configuração foi bem-sucedida.


Volte para a página anterior e clique em "Gerenciar Permissões" para o campo de Webhook Personalizado.



Ative a permissão de Webhook Personalizado para aqueles que irão acionar eventos de Webhook ao receber mensagens no WhatsApp.


Para garantir que a integração com o Webhook esteja configurada corretamente, lembre-se de atualizar tanto o seu WhatsApp Web quanto o WhatsApp Web dos membros da sua equipe após qualquer alteração nas configurações.
Todos os usuários da equipe com permissão de integração verão o pop-up "Conceder Acesso ao Cooby" na próxima vez que abrirem ou atualizarem o WhatsApp Web.



Após receber o payload, você poderá usá-lo para configurar várias ações.

Formato do Payload

{
  chat_id: string;
  chat_type: "group" | "individual";
  chat_title: string;
  user_phone: string;
  user_email: string;
  direction: "sent" | "received";
  message: {
    id: string;
    type: "call_log" | "chat" | "location" | "payment" | "vcard" | "ciphertext" | "multi_vcard" | "revoked" | "oversized" |   "groups_v4_invite" | "template_button_reply" | "debug" | "image" | "video" | "audio" | "sticker" | "status_v3" | "document" | "product" | "order" | "list" | "interactive" | "interactive_response" | "list_response" | "buttons_response" | "reaction" | "reaction_enc" | "poll_creation" | "request_phone_number" | "poll_update" | "native_flow" | "biz-cover-photo" | "keep_in_chat" | "pin_message" | "unknown";
    text: string;
    file_name: string | null;
    file_url: string| null;
    caption: string | null;
    is_error: boolean;
    error_code: string | null;
    error_message: string | null;
  };
  timestamp: string;
  participants: {
    phone: string;
    wa_name: string;
  }[];
  sender: {
    phone: string;
    wa_name: string;
  };
}

Exemplo de Payload

{
  chat_id: "447441369136_447441368384@c.us";
  chat_type: "individual";
  chat_title: "Sarah Brown";
  user_phone: "447441368384";
  user_email: "support@cooby.co";
  direction: "sent";
  message: {
    id: "3EB093D273669B3BE3D2";
    type: "chat";
    text: "Hi, welcome to Cooby!";
    file_name: "Cooby Image 2023-07-12 at 11.13.32 AM";
    file_url: "https://api.cooby.co/v2/files/xxxxx";
    caption: "Hi, welcome to Cooby!";
    is_error: false;
    error_code: null;
    error_message: null;
  };
  timestamp: "1628843453";
  participants: [
   {
    phone: "447441369136";
    wa_name: "Sarah Brown";
   },
   { 
    phone: "447441368384", 
    wa_name: "Cooby" 
   } 
  ],
  sender: {
    phone: "447441368384";
    wa_name: "Cooby";
  };
}

Saiba mais sobre a definição de cada coluna

Saiba mais sobre a frequência de sincronização da Integração com Webhook

Saiba mais sobre o mecanismo de sincronização da Integração com Webhook

Saiba mais sobre a sincronização de mensagens históricas na integração com Webhook

Esperamos que este documento ajude você a entender melhor como funciona o Cooby. Para qualquer dúvida ou questão sobre a sua integração com Webhook Personalizado, entre em contato pelo e-mail support@cooby.co 💜

Actualizado em: 18/06/2025