Um webhook é um callback HTTPS criado pelo parceiro que especifica como seu agente precisa responder a mensagens e eventos. A menos que você use um modelo do Google, como o Dialogflow, você precisa configurar um webhook personalizado para definir o comportamento do seu agente.
Webhooks no nível do parceiro e do agente
É possível definir seu webhook no nível do parceiro ou do agente. Os webhooks no nível do parceiro se aplicam a todos os agentes que você mantém. Já no nível do agente, cada um deles se aplica a um agente individual.
Se você opera vários agentes com comportamento distinto, defina um webhook diferente para cada agente usando a configuração no nível do agente. No outro caso seus agentes tenham um comportamento semelhante ou caso haja apenas um agente, podem usar o webhook no nível do parceiro.
Se você tiver configurado um webhook no nível do parceiro e outro no nível do agente, o webhook no nível do agente tem precedência sobre seu agente específico, enquanto o O webhook no nível do parceiro se aplica a agentes que não têm um nível de agente ou webhook.
Definir o webhook no nível do parceiro
Para definir o webhook no nível do parceiro, siga estas etapas:
- Abra o Console para desenvolvedores do Business Communications. e faça login com sua Conta do Google no Business Messages.
- Abra as Configurações da conta.
- Verifique se a conta do parceiro correta está selecionada.
- Em URL do webhook do Business Messages, clique em Configurar.
- Em URL do endpoint do webhook, insira o URL do aplicativo + "/callback/". Por exemplo, pode ser algo como "https://PROJECT_ID.appspot.com/callback/".
- Anote o valor de
clientToken
. Você precisa dela para confirmar se as mensagens que recebe são provenientes do Google. Configure seu webhook para aceitar uma solicitação POST com o tipo o parâmetro
clientToken
e enviar uma resposta200 OK
com o texto simples do parâmetro secreto como o corpo da resposta. Por exemplo, suponha O webhook recebe uma solicitação POST com o seguinte conteúdo do corpo:{ "clientToken":"SJENCPGJESMGUFPY", "secret":"0123456789" }
Nesse caso, o webhook precisa confirmar o valor
clientToken
e, seclientToken
está correta, retorne uma resposta200 OK
com0123456789
como o corpo da resposta.No console, clique em Verificar. Quando o recurso Business Messages verifica seu webhook, a caixa de diálogo é fechada.
Definir um webhook no nível do agente
Você recebe mensagens enviadas ao agente no webhook no nível do parceiro. Se você quiser que as mensagens de um agente específico cheguem em um webhook diferente, pode definir um webhook no nível do agente.
- Abra o Console para desenvolvedores do Business Communications. e faça login com sua Conta do Google no Business Messages.
- Clique no seu agente.
- Clique em Integrations.
- Em Webhook, clique em Configurar.
- Em URL do endpoint do webhook, insira o URL do webhook, que começa com "https://".
- Anote o valor de
clientToken
. Ela é necessária para verificar se as mensagens enviadas que recebem vêm do Google. Configure seu webhook para aceitar uma solicitação POST com o tipo
clientToken
e envie uma resposta 200 OK com o valor do parâmetro secreto. Por exemplo, suponha que o webhook receba uma solicitação POST pelo seguinte conteúdo de corpo:{ "clientToken":"SJENCPGJESMGUFPY", "secret":"0123456789" }
Nesse caso, o webhook precisa confirmar o valor
clientToken
e, seclientToken
está correta, retorne uma resposta200 OK
com o URL secreto definido como0123456789
.No console, clique em Verificar. Quando o recurso Business Messages verifica seu webhook, a caixa de diálogo é fechada.