> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.cooby.co/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# 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

1. Acesse o [Centro de Integração](https://app.cooby.co/integrations) do seu workspace
2. Encontre "Webhook Personalizado" e clique em "Guia de Integração".

![](https://storage.crisp.chat/users/helpdesk/website/-/a/7/7/6/a776868fb0318800/2_1ubhsho.png =370x650)
3. Crie um endpoint de Webhook no seu destino desejado.
* Lembre-se de marcar a opção **"CORS Headers"**.

![](https://storage.crisp.chat/users/helpdesk/website/-/a/7/7/6/a776868fb0318800/3_4stcpg.png =850x315)

4. 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".

![](https://storage.crisp.chat/users/helpdesk/website/-/a/7/7/6/a776868fb0318800/4_1a3bmpl.png =850x255)
5. Verifique se a URL do Webhook foi salva, indicando que a configuração foi bem-sucedida.

![](https://storage.crisp.chat/users/helpdesk/website/-/a/7/7/6/a776868fb0318800/5_vy1c9n.png =850x472)
Volte para a página anterior e clique em "Gerenciar Permissões" para o campo de Webhook Personalizado.

![](https://storage.crisp.chat/users/helpdesk/website/-/a/7/7/6/a776868fb0318800/6_1grbxh0.png =383x650)

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

![](https://storage.crisp.chat/users/helpdesk/website/-/a/7/7/6/a776868fb0318800/7_cyh7fk.png =850x186)
8. 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.

![](https://storage.crisp.chat/users/helpdesk/website/-/a/7/7/6/a776868fb0318800/8_tibdhc.png =850x495)

9. 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](https://help.cooby.co/pt/article/definicoes-das-colunas-do-webhook-1nbxxow/)

[Saiba mais sobre a frequência de sincronização da Integração com Webhook](https://help.cooby.co/pt/article/frequencia-de-sincronizacao-da-integracao-com-webhook-1u15j3b/)

[Saiba mais sobre o mecanismo de sincronização da Integração com Webhook](https://help.cooby.co/pt/article/mecanismo-de-sincronizacao-da-integracao-com-webhook-z3lvws/)

[Saiba mais sobre a sincronização de mensagens históricas na integração com Webhook](https://help.cooby.co/pt/article/sincronizacao-de-mensagens-historicas-na-integracao-com-webhook-1dwed5o/)

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 💜