Consulte os conectores compatíveis com a Application Integration.

Gatilho de webhook

Visualização — Webhook trigger

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

O gatilho de webhook é um acionador de evento de conector que permite invocar uma integração com base em qualquer evento compatível com webhooks.

Importante:o Integration Connectors é um componente faturável do Google Cloud. Saiba mais sobre os custos e as cobranças do uso do Integration Connectors em Preços do Integration Connectors.

Antes de começar

Se você planeja criar ou configurar uma nova conexão para o Gatilho de webhook, verifique se tem o seguinte papel do Identity and Access Management (IAM) no projeto:

• Administrador de conectores (roles/connectors.admin)

Para informações sobre como conceder papéis, consulte Gerenciar acesso.

Conceda os seguintes papéis do IAM à conta de serviço que você quer usar para o gatilho de webhook:

• Invocador do Application Integration (roles/integrations.integrationInvoker)

Para informações sobre como conceder papéis a uma conta de serviço, consulte Gerenciar o acesso a contas de serviço.

Adicionar o gatilho de webhook

Para adicionar um gatilho de webhook à sua integração, siga estas etapas:

1. No console do Google Cloud, acesse a página Application Integration.

   Acessar o Application Integration

2. No menu de navegação, clique em Integrações.

   A página Lista de integrações aparece listando todas as integrações disponíveis no projeto do Google Cloud.

3. Selecione uma integração existente ou clique em Criar integração para criar uma nova.

   Se você estiver criando uma integração:

   1. Digite um nome e uma descrição no painel Create Integration.
   2. Selecione uma região para a integração.
      Observação: o menu suspenso Regiões lista apenas as regiões provisionadas no projeto do Google Cloud. Para provisionar uma nova região, clique em Ativar região. Consulte Ativar nova região para obter mais informações.
   3. Selecione uma conta de serviço para a integração. Você pode mudar ou atualizar os detalhes da conta de serviço de uma integração a qualquer momento no painel Resumo da integração na barra de ferramentas.
      Observação:a opção de selecionar uma conta de serviço só vai aparecer se você tiver ativado a governança de integração na região selecionada.
   4. Clique em Criar.

   Isso abre a integração na página do editor de integração.

4. Na barra de navegação do editor de integração, clique em Gatilhos para conferir a lista de gatilhos disponíveis.
5. Clique e coloque o elemento Gatilho do webhook no editor de integração.

Para configurar o Gatilho de webhook, use uma conexão de webhook atual disponível nos Integration Connectors ou crie uma nova com a opção de criação de conexão inline.

Configurar o gatilho de webhook usando uma conexão atual

Você pode configurar o Gatilho do Webhook usando uma conexão de Webhook atual nos Integration Connectors. O gatilho de webhook é um acionador de evento do conector. Portanto, só é possível usar uma conexão de webhook com a inscrição de eventos ativada para configurar o acionador.

Saiba como configurar um acionador de webhook usando uma nova conexão em Configurar o gatilho de webhook usando uma nova conexão.

Para configurar um acionador de webhook usando uma conexão atual, siga estas etapas:

1. Clique no elemento Gatilho de webhook no editor de integração para abrir o painel de configuração do gatilho.
2. Clique em Configurar gatilho.
3. Forneça os seguintes detalhes de configuração na página Editor do gatilho de evento do conector:
   1. Região:selecione a região da sua conexão de webhook.
   2. Conexão:selecione a conexão de webhook que você quer usar.

      A Application Integration exibe apenas as conexões de webhook que estão ativas e com uma inscrição de eventos ativada.

   3. Tipo de assinatura de evento:insira o tipo de evento que você quer usar para acionar a integração.
   4. Conta de serviço: selecione uma conta de serviço com os papéis do IAM necessários para o gatilho de webhook.
4. Clique em Concluído para finalizar a configuração do acionador e fechar a página.

Para mais informações, consulte a documentação Conexão com o webhook.

Configurar o gatilho de webhook usando uma nova conexão

Para configurar o Gatilho do webhook usando uma nova conexão, siga estas etapas:

1. Clique no elemento Gatilho de webhook no editor de integração para abrir o painel de configuração do gatilho.
2. Clique em Configurar gatilho.
3. Ignore o campo Região.
4. Clique em Conexão e selecione a opção Criar conexão no menu.
5. Siga estas etapas no painel Criar conexão:
   1. Na seção Local, escolha o local da conexão.
      1. Região: selecione um local na lista.

         Veja abaixo as regiões com suporte com o conector:

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

      2. Clique em Próxima.
   2. 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: digite 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 63 caracteres.
      4. Descrição: como opção, 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 inscrição em eventos será ativada por padrão e é obrigatória para o conector de webhook.
         Observação : a opção Enable event subscription, entity and actions não é compatível com essa conexão.
      7. Também é possível clicar em + Adicionar rótulo para incluir um rótulo na conexão na forma de um par de chave-valor.
      8. Clique em Próxima.
   3. Na seção Event Subscription Details, 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 do webhook:

         • Sem autenticação
         • Autenticação do Google: verifique se a conta de serviço tem o papel roles/connectors.listener cujo token de acesso é usado para autenticação.
         • Autenticação da chave de API
         • Autenticação básica
      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 do tipo de evento: o campo obrigatório no local configurado identifica o tipo de evento associado à solicitação de evento recebida.

      {
      "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.criadas".
      4. Selecione Ativar conectividade particular para conectividade segura entre seu aplicativo de back-end e sua conexão. Se você selecionar essa opção, precisará executar etapas de configuração adicionais depois de criar a conexão. Para mais informações, consulte Conectividade particular para inscrição em eventos.
      5. Insira a configuração de mensagens inativas. Se você configurar a mensagem inativa, a conexão gravará os eventos não processados no tópico do Pub/Sub especificado. Digite os seguintes detalhes:
         1. ID do projeto de mensagens inativas: o ID do projeto do Google Cloud em que você configurou o tópico do Pub/Sub de mensagens inativas.
         2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer escrever os detalhes do evento não processado.
      6. Clique em Próxima.
   4. Revisão: revise os detalhes de autenticação da conexão e do listener.
   5. Clique em Criar.

Saída do gatilho

O gatilho de webhook leva alguns minutos para concluir a configuração da inscrição de eventos. É possível ver o status da sua assinatura de eventos no painel de configuração do acionador, em Detalhes da inscrição de eventos.

O gatilho de webhook indica o status de uma inscrição em um evento usando os seguintes estados:

• Creating: indica que o acionador está assinando a assinatura do evento.
• Active: indica que o acionador foi inscrito em uma assinatura de evento.
• Error: indica que há um problema com a inscrição de eventos configurada.

Além do status da inscrição no evento, a seção Detalhes da inscrição no evento também exibe outras informações, como região da conexão, nome da conexão, nome da inscrição do evento e muito mais.

Variável de saída do acionador

Para cada evento, o gatilho do webhook gera uma variável de saída ConnectorEventPayload que pode ser usada nas tarefas downstream. A variável de saída está no formato JSON, que contém o esquema de payload de saída do webhook.

Ver inscrições em eventos

Para conferir e gerenciar todas as assinaturas de eventos associadas a uma conexão no Integration Connectors, faça o seguinte:

1. Acesse a página Conectores de integração > Conexões.

   Acessar a página "Conexões"

2. Clique na conexão em que você quer exibir as assinaturas.
3. Clique na guia Inscrições em eventos.

   Todas as inscrições de eventos da conexão são exibidas.

Editar gatilho de webhook

Você pode editar um gatilho de webhook para alterar ou atualizar a configuração de conexão e os detalhes de inscrição de eventos.

Importante:ao editar ou modificar um acionador de webhook, é possível manter a assinatura de evento configurada anteriormente que está anexada ao acionador ou excluí-la. A exclusão de uma assinatura de evento afeta todas as integrações publicadas que usam essa assinatura.

Para editar um gatilho de webhook, siga estas etapas:

1. Clique no elemento Gatilho de webhook no editor de integração para abrir o painel de configuração do gatilho.
2. Clique em Configurar gatilho de webhook.
3. Faça o seguinte na página Editor do gatilho de evento do conector:
   1. Para manter a assinatura de eventos configurada anteriormente, clique em Reter. Caso contrário, clique em Excluir.
      Aviso:a exclusão de uma assinatura de evento afeta todas as integrações publicadas que usam essa assinatura. Esta tarefa não pode ser desfeita.
   2. Atualize a configuração da conexão e os detalhes da inscrição no evento conforme desejado.
   3. Clique em Concluído.

Você pode ver os detalhes atualizados da conexão e das inscrições de eventos no painel de configuração do acionador, em Detalhes da inscrição de eventos.