Webhooks

Webhooks são serviços que hospedam sua lógica de negócios ou chamar outros serviços. Durante uma sessão, os webhooks permitem que você use os dados extraídos pelo processamento de idioma natural do Dialogflow para gerar respostas dinâmicas, validar dados coletados ou ativar ações no back-end.

Ele pode ser padrão ou flexível. Com um webhook padrão, os campos de solicitação e resposta são definidos pelo Dialogflow. Com um webhook flexível, você define os campos de solicitação e resposta.

Webhooks padrão

Com os webhooks padrão, você usa mensagens de solicitação e resposta definidas pelo Dialogflow. A mensagem de solicitação fornece muitos detalhes sobre a sessão. Por exemplo, página ativa atual, intent com correspondência recente valores de parâmetros de sessão e respostas definidas pelo agente estão incluídos.

Solicitação de webhook padrão

Quando um fulfillment com um webhook é chamado, o Dialogflow envia uma solicitação de webhook POST HTTPS para seu serviço de webhook. O corpo dessa solicitação é um objeto JSON WebhookRequest com informações sobre a sessão.

Algumas integrações preencha o campo WebhookRequest.payload com informações adicionais. Por exemplo, o Integração do gateway de telefone do Dialogflow CX fornece o identificador de chamadas do usuário final.

Consulte a documentação de referência de WebhookRequest(V3) ou WebhookRequest(V3Beta1) para mais detalhes.

Resposta padrão do webhook

Uma vez que seu serviço de webhook recebe uma solicitação de webhook, ela precisa enviar uma resposta a um webhook. As seguintes limitações se aplicam à sua resposta:

  • A resposta precisa ocorrer dentro de um tempo limite que você configura ao criar o recurso de webhook. Caso contrário, a solicitação atingirá o tempo limite.
  • É necessário que o tamanho da resposta seja menor ou igual a 64 KiB.

Consulte a documentação de referência de WebhookResponse(V3) ou WebhookResponse(V3Beta1) para mais detalhes.

Configurações de recursos do webhook padrão

Veja a seguir a descrição das configurações de recursos do webhook para webhooks padrão:

Termo Definição
Nome de exibição O nome do webhook mostrado no console.
Tempo limite do webhook Quando o Dialogflow envia uma solicitação de webhook ao serviço, ele pode atingir o tempo limite enquanto aguarda uma resposta. Essa configuração controla o tempo limite em segundos. Se o tempo limite for atingido, o Dialogflow invocará um evento webhook.error.timeout.
Tipo Defina como Diretório de serviços se estiver usando o diretório de serviços para acesso à rede particular. Caso contrário, defina como Serviço da Web genérico.
URL do webhook Informe o endereço URL do serviço de webhook.
Subtipo Definido como Padrão
Webhook específico do ambiente É possível fornecer webhooks específicos do ambiente.
Autenticação Consulte a seção de autenticação.
Certificado de CA personalizado Isso é usado para fazer upload de certificados de CA personalizados.

Webhooks flexíveis

Com webhooks flexíveis, você define o método HTTP de solicitação, os parâmetros do URL de solicitação e os campos das mensagens de solicitação e resposta. A solicitação só pode fornecer valores de parâmetros selecionados, e a resposta só pode fornecer valores de substituição de parâmetro. Essa limitação é benéfica, porque isso simplifica a interface entre o agente e o webhook. Raramente há a necessidade de comunicar algo além de parâmetros de sessão entre um agente e um webhook. Isso também simplifica a implementação do webhook, porque as mensagens de solicitação e resposta contêm apenas o que você precisa, e fornecer mensagens de webhook únicas para vários cenários.

Solicitação de webhook flexível

Ao criar o recurso de webhook para seu agente, é possível especificar o seguinte para solicitações de webhook:

  • O método HTTP usado para solicitações de webhook enviados ao serviço de webhook.
  • Valores de parâmetro de sessão que o Dialogflow deve enviar ao serviço de webhook usando o URL.
  • Se você escolher POST, PUT ou PATCH como método, é possível especificar valores de parâmetros de sessão que o Dialogflow deve enviar para seu serviço de webhook usando o corpo JSON da solicitação.

Para enviar valores de parâmetro de sessão usando o URL de solicitação ou o corpo JSON, use referências de parâmetros como você faria normalmente. Não é necessário fazer o escape do URL da referência de parâmetro. e você não colocar a referência entre aspas. No ambiente de execução, O Dialogflow fará o escape do URL do valor do parâmetro conforme necessário. Uma lista ou valor composto será fornecido no formato JSON.

Ao usar uma referência de parâmetro no corpo JSON, você deve colocar a referência entre aspas, seja qual for o tipo de parâmetro. Se o parâmetro for um valor numérico escalar, de lista ou composto, O Dialogflow removerá as aspas ao enviar a solicitação no ambiente de execução para preservar o tipo de dados do parâmetro. Os tipos escalares de string vão continuar entre aspas. Se um valor numérico, de lista ou composto for referenciado dentro de um valor de string (por exemplo: "Este é um número: $session.params.size"), o parâmetro será tratado como uma string ("Este é um número: 3").

Por exemplo: é possível fornecer os valores de parâmetro da sessão fruit e size. ao URL de solicitação da seguinte forma:

https://your-webhook-service.com/handler?f=$session.params.fruit&s=$session.params.size

E para o corpo JSON da solicitação, da seguinte forma:

{
  "fruitParameter": "$session.params.fruit",
  "sizeParameter": "$session.params.size"
}

Resposta flexível do webhook

Ao criar o recurso de webhook para seu agente, especifique os parâmetros de sessão que o Dialogflow deve definir a campos específicos da resposta do webhook no ambiente de execução.

As seguintes limitações se aplicam à sua resposta:

  • A resposta precisa ocorrer dentro de um tempo limite que você configura ao criar o recurso de webhook. Caso contrário, a solicitação atingirá o tempo limite.
  • É necessário que o tamanho da resposta seja menor ou igual a 64 KiB.

Use o seguinte formato para especificar um campo escalar, lista ou composto:

$.fully.qualified.path.to.field

Por exemplo: considere a seguinte resposta JSON:

{
  "routes" : [
    {
      "legs" : [
        {
          "distance" : {
            "text" : "2,064 mi",
            "value" : 3321004
          }
        }
      ]
    }
  ]
}

Para especificar o "value" campo use o seguinte:

$.routes[0].legs[0].distance.value

Configurações flexíveis de recursos do webhook

Veja a seguir as configurações de recursos do webhook para webhooks flexíveis:

Termo Definição
Nome de exibição O nome do webhook mostrado no console.
Tempo limite do webhook Quando o Dialogflow envia uma solicitação de webhook ao serviço, ele pode atingir o tempo limite enquanto aguarda uma resposta. Essa configuração controla o tempo limite em segundos. Se o tempo limite for atingido, o Dialogflow invocará um evento webhook.error.timeout.
Tipo Defina como Diretório de serviços se estiver usando o diretório de serviços para acesso à rede particular. Caso contrário, defina como Serviço da Web genérico.
URL do webhook Informe o endereço URL do seu serviço de webhook, que pode incluir referências a parâmetros de sessão.
Subtipo Defina como flexível.
Método Defina o método HTTP para a solicitação do webhook.
Corpo da solicitação Forneça o corpo JSON da solicitação conforme descrito acima.
Configuração de resposta Forneça os parâmetros da sessão que precisam ser definidos para os campos de resposta, conforme descrito acima.
Webhook específico do ambiente É possível fornecer webhooks específicos do ambiente.
Autenticação Consulte a seção de autenticação.
Certificado de CA personalizado Isso é usado para fazer upload de certificados de CA personalizados.

Usar um modelo personalizado predefinido

O Dialogflow oferece modelos personalizados predefinidos que podem ser usados integrar webhooks flexíveis com o CRM do Salesforce.

  1. Na guia Manage, clique em Webhooks e em + Create.

  2. Em Subtipo, selecione Flexível.

  3. Clique em Configurar usando um modelo predefinido para ativar o recurso.

  4. No menu suspenso Tipo de integração, selecione Salesforce.

  5. No menu suspenso Nome da API, selecione um nome de API. O modelo preenche automaticamente o formulário de webhook com base no nome da API que você que você escolher.

    1. É possível configurar manualmente os campos a seguir, se aplicável, com base no seus parâmetros:

      • URL do webhook
      • Método
      • Corpo da solicitação JSON
      • Configuração da resposta

    2. Os campos OAuth obrigatórios serão destacados em Autenticação nesta seção.

  6. Clique em Salvar para criar o webhook.

Requisitos de serviço do webhook

Os seguintes requisitos devem ser atendidos pelo serviço do webhook:

Autenticação

É importante proteger seu serviço de webhook para que somente você ou seu agente do Dialogflow sejam autorizados a fazer solicitações. Isso é configurado ao criar um recurso de webhook. O Dialogflow CX é compatível com os seguintes mecanismos de autenticação:

Termo Definição
Cabeçalhos de autenticação Nas configurações do webhook, especifique pares de chave-valor do cabeçalho HTTP opcionais. Se fornecidos, o Dialogflow adiciona esses cabeçalhos HTTP às solicitações de webhook. É comum fornecer um único par com uma chave de authorization. Os valores do cabeçalho são compatíveis com referências de parâmetros de sessão e análise de funções do sistema como em mensagens de resposta estática.
Autenticação básica com nome de usuário e senha Nas configurações do webhook, é possível especificar valores opcionais de nome de usuário e senha de login. Se fornecido, o Dialogflow adiciona um cabeçalho HTTP de autorização às solicitações do webhook. Esse cabeçalho tem o formato: "authorization: Basic <base 64 encoding of the string username:password>".
OAuth de terceiros É possível especificar a configuração de OAuth de terceiros para que o Dialogflow troque um token de acesso do provedor de OAuth e o adicione ao cabeçalho HTTP de autorização. Somente o fluxo de credenciais do cliente é aceito.
Tokens de acesso do agente de serviço Selecione o token de acesso na autenticação do agente de serviço para usar tokens de acesso do agente de serviço na autenticação. Isso pode ser usado para acessar outras APIs do Google Cloud.
Tokens de ID do agente de serviço Selecione o token de ID na autenticação do agente de serviço para usar tokens de ID do agente de serviço na autenticação. Isso pode ser usado para acessar os serviços do função do Cloud e do Cloud Run. Se nenhuma outra opção de autenticação for usada, ela será ativada por padrão.
Autenticação TLS mútua Consulte a documentação Autenticação TLS mútua.

Verificação do certificado HTTPS

Por padrão, o Dialogflow usa o armazenamento de confiança padrão do Google para verificar certificados HTTPS. Se você quiser usar certificados não reconhecidos pelo armazenamento de confiança padrão do Google para seu servidor HTTPS, como certificados autoassinados ou certificados raiz personalizados, consulte Certificados de CA personalizados.

Webhooks específicos de ambiente

Se você estiver usando ambientes para isolar sistemas de produção de sistemas de desenvolvimento (recomendado), é possível configurar seus webhooks para serem específicos do ambiente. Para cada recurso do webhook definido, você pode fornecer configurações de autenticação e URL exclusivos para cada ambiente definido para o agente.

Isso permite desenvolver e testar com segurança as atualizações do código do webhook antes de implantá-los na produção.

Criar ou editar recursos do webhook

Depois de ter um serviço de webhook em execução, você precisa criar um recurso de webhook no agente que tenha informações de conectividade e autenticação. Após a criação, também será possível editar as configurações de recursos do webhook a qualquer momento.

Para criar ou editar um recurso do webhook:

Console

  1. Abra o Console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Clique em Criar ou em um recurso de webhook na lista para editar.
  7. Informe as configurações padrão do recurso de webhook. ou configurações flexíveis de recursos de webhook.
  8. Clique em Salvar.

API

Para criar um recurso de webhook, consulte o método create para o tipo Webhook. Para editar um recurso de webhook (exceto configurações específicas do ambiente), consulte o método patch ou update para o tipo Webhook.

Selecione um protocolo e uma versão para a referência do Webhook:

Protocolo V3 V3beta1
REST Recurso de webhook Recurso de webhook
RPC Interface do webhook Interface do webhook
C++ WebhooksClient Indisponível
C# WebhooksClient Indisponível
Go WebhooksClient Indisponível
Java WebhooksClient WebhooksClient
Node.js WebhooksClient WebhooksClient
PHP Indisponível Indisponível
Python WebhooksClient WebhooksClient
Ruby Indisponível Indisponível

Para editar as configurações específicas do ambiente para um webhook, faça o seguinte: consulte o método patch ou update para o tipo Environment.

Selecione um protocolo e uma versão para a Referência de ambiente:

Protocolo V3 V3beta1
REST Recurso de ambiente Recurso de ambiente
RPC (remote procedure call) Interface do ambiente Interface do ambiente
C++ EnvironmentsClient Indisponível
C# EnvironmentsClient Indisponível
Go EnvironmentsClient Indisponível
Java EnvironmentsClient EnvironmentsClient
Node.js EnvironmentsClient EnvironmentsClient
PHP Indisponível Indisponível
Python EnvironmentsClient EnvironmentsClient
Ruby Indisponível Indisponível

Erros de webhook

Se o serviço de webhook encontrar um erro ao processar uma solicitação do webhook, o código do webhook retornará um dos seguintes códigos de status HTTP:

  • 400 Solicitação inválida
  • 401 Não autorizado
  • 403 Proibido
  • 404 Não encontrado
  • 500 Falha no servidor
  • 503 Serviço não disponível

Em qualquer uma das situações de erro a seguir, o Dialogflow invoca um erro de webhook ou evento integrado de tempo limite e continua processando normalmente:

  • Tempo limite de resposta excedido.
  • Código de status de erro recebido.
  • A resposta é inválida.
  • O serviço de webhook não está disponível.

Além disso, se a chamada de serviço do webhook tiver sido acionada por uma chamada de API de intent de detecção, o campo queryResult.webhookStatuses na resposta de intent de detecção conterá as informações de status do webhook.

Como usar o Cloud Functions

O Dialogflow se integra ao Cloud Functions para que você crie facilmente um webhook seguro e sem servidor. Se você criar uma função que resida no mesmo projeto do agente, ele poderá chamar com segurança o webhook sem precisar de nenhuma configuração especial.

No entanto, há duas situações em que é preciso configurar essa integração manualmente:

  1. O agente de serviço do Dialogflow conta de serviço com o seguinte endereço deve existir para seu projeto de agente: 
    service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com
    Essa conta de serviço especial e a chave associada é normalmente criado de modo automático quando você cria o primeiro agente para um projeto. Se o agente foi criado antes de 1o de novembro de 2020, talvez você acione a criação desta conta de serviço especial:
    1. Crie um novo agente para o projeto.
    2. Execute este comando: 
      gcloud beta services identity create --service=dialogflow.googleapis.com --project=agent-project-id
  2. Se a função do webhook residir em um projeto diferente do agente, forneça o Papel do IAM Invocador do Cloud Functions à conta de serviço Agente de serviço do Dialogflow no projeto da função.

Como usar webhooks conteinerizados e o framework do Go ezcx

Se você quiser implementar um webhook conteinerizado usando Go, consulte o Framework do Go ezcx. Esse framework pode simplificar muitas das etapas necessárias na criação de um webhook.

Como usar o diretório de serviços para acesso a redes privadas

O Dialogflow integra-se ao acesso à rede particular do Diretório de serviços para que ele possa se conectar aos destinos do webhook dentro da rede VPC. Isso mantém o tráfego na rede do Google Cloud e aplica o IAM e o VPC Service Controls.

Para configurar um webhook que segmenta uma rede privada:

  1. Siga a configuração de rede particular do Diretório de serviços para configurar sua rede VPC e o endpoint do Diretório de serviços.

  2. O agente de serviço do Dialogflow conta de serviço com o seguinte endereço deve existir para seu projeto de agente: 

    service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com
    Conceda à conta de serviço do Agente de serviço do Dialogflow os seguintes papéis do IAM:

    • servicedirectory.viewer do projeto do diretório de serviços
    • servicedirectory.pscAuthorizedService do projeto de rede

  3. Forneça o serviço do diretório de serviços com o URL e informações de autenticação opcionais ao criar o webhook.

    Console

    Captura de tela do webhook do Diretório de serviços.

    API

    Veja o campo serviceDirectory para o tipo Webhook.

    Selecione um protocolo e uma versão para a referência do Webhook:

    Protocolo V3 V3beta1
    REST Recurso de webhook Recurso de webhook
    RPC Interface do webhook Interface do webhook
    C++ WebhooksClient Indisponível
    C# WebhooksClient Indisponível
    Go WebhooksClient Indisponível
    Java WebhooksClient WebhooksClient
    Node.js WebhooksClient WebhooksClient
    PHP Indisponível Indisponível
    Python WebhooksClient WebhooksClient
    Ruby Indisponível Indisponível

Para resolver problemas, configure uma verificação de tempo de atividade particular para verificar se o diretório de serviços está configurado corretamente.

Autenticação do agente de serviço

O Dialogflow pode gerar Token de ID ou token de acesso usando Agente de serviço do Dialogflow.

O token é adicionado ao cabeçalho HTTP de autorização quando o Dialogflow chama um webhook.

Token de ID

Um token de ID pode ser usado para acessar os serviços da Função do Cloud e do Cloud Run depois que você concede o papel Invocador a 

service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com
Se os serviços do função do Cloud e do Cloud Run estiverem no mesmo projeto de recurso, não serão necessárias permissão do IAM para chamá-las.

O público-alvo usado para gerar o token de ID será o URL inteiro do webhook, exceto os parâmetros de consulta. Se você estiver usando o Cloud Run, verifique se os públicos-alvo do Cloud Run oferecem suporte a esse URL. Por exemplo, se o URL do webhook for

https://myproject.cloudfunctions.net/my-function/method1?query=value

o URL a seguir precisa estar em públicos-alvo personalizados.

https://myproject.cloudfunctions.net/my-function/method1

Qualquer webhook também pode validar o token usando bibliotecas de cliente do Google ou bibliotecas de código aberto, como github.com/googleapis/google-auth-library-nodejs.

Token de acesso

Um token de acesso pode ser usado para acessar outras APIs do Google Cloud depois que você concede os papéis necessários para 

service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com

Amostras e solução de problemas

Consulte a guia de instruções do webhook.

Anterior
Fulfillments
Próxima
Modelos de fala