Webhook

O conector de webhook permite detectar eventos do back-end que oferecem suporte a webhooks. Este conector foi projetado para ser usado com o acionador de webhook. O gatilho de webhook recebe eventos de aplicativos SaaS de terceiros que oferecem suporte à capacidade de eventos de webhook. Esse gatilho oferece suporte a vários tipos de autenticação para o listener de eventos. Para usar o gatilho de webhook na integração, primeiro configure um conector de webhook.

Antes de começar

Antes de usar o conector de webhook, faça o seguinte:

  • No seu projeto na nuvem do Google Cloud:
    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. O conector e a conta de serviço precisam pertencer ao mesmo projeto. Para mais informações, consulte Como criar uma conta de serviço.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, faça o seguinte:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + Criar novo para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em Próxima.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione Webhook na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. Nome da conexão: insira um nome para a instância de conexão.

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 49 caracteres.
      • Para conectores que oferecem suporte à assinatura de eventos, os nomes de conexão não podem começar com o prefixo "goog".
    4. Descrição: opcionalmente, insira uma descrição para a instância de conexão.
    5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    6. Assinatura de eventos: a assinatura de eventos é ativada por padrão e é obrigatória para o conector de webhook.
    7. Outra opção é clicar em + Adicionar marcador para adicionar um marcador à conexão na forma de um par de chave-valor.
    8. Clique em Próxima.
  5. Na seção Detalhes da assinatura de eventos, faça o seguinte:
    1. Autenticação do listener: selecione um tipo de autenticação para o listener de eventos e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com o listener de webhook:

    2. Local do campo de tipo de evento: campo obrigatório que indica o local (cabeçalho, parâmetro de consulta ou corpo da solicitação) em que o tipo de evento associado à solicitação de evento recebida estará presente.
    3. Nome do campo de tipo de evento: campo obrigatório no local configurado que identifica o tipo de evento associado à solicitação de evento recebida.
      4. {
"event_type": "user.created",
...
// other request fields
...
}
       No exemplo acima, o campo event_type no corpo da solicitação significa que a solicitação pertence a um evento "user.created".
    4. Selecione Ativar conectividade particular para conectividade segura entre o aplicativo de back-end e a conexão. Se você selecionar essa opção, será necessário executar mais etapas de configuração depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinatura de eventos.
    5. Insira a configuração de mensagens não entregues. Se você configurar mensagens não entregues, a conexão vai gravar os eventos não processados no tópico do Pub/Sub especificado. Insira os seguintes detalhes:
      1. ID do projeto de mensagens não entregues: o ID do projeto na nuvem do Google Cloud em que você configurou o tópico do Pub/Sub de mensagens não entregues.
      2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.
    6. Clique em Próxima.
  6. Revisão: revise os detalhes de conexão e autenticação do listener.
  7. Clique em Criar.

Usar a conexão de webhook em uma integração

Depois de criar a conexão, ela fica disponível na Apigee Integration e na Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

  • Para entender como criar e usar a tarefa de conectores na integração da Apigee, consulte Tarefa de conectores.
  • Para entender como criar e usar a tarefa de conectores no Application Integration, consulte Tarefa de conectores.

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir