Consulte os conetores suportados para a solução Application Integration.

Acionador de webhook

Pré-visualização — Webhook trigger

Esta funcionalidade está sujeita aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais de Serviço dos Termos Específicos do Serviço. As funcionalidades de pré-DG estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

O acionador de webhook é um acionador de eventos de conector que lhe permite invocar uma integração com base em quaisquer eventos do back-end que suportem webhooks. O acionador de webhook recebe eventos de aplicações baseadas em SaaS de terceiros que suportam a capacidade de eventos de webhook. Este acionador suporta vários tipos de autenticação para o ouvinte de eventos e aceita apenas payloads JSON.

Importante: os conetores de integração são um componente faturável do Google Cloud. Para informações sobre os custos e as cobranças da utilização dos Conetores de integração, consulte o artigo Preços dos Conetores de integração.

Antes de começar

Se planeia criar ou configurar uma nova associação para o Acionador de webhook, certifique-se de que tem a seguinte função de Identity and Access Management (IAM) no projeto:

• Administrador do conetor (roles/connectors.admin)

Para informações sobre a concessão de funções, consulte o artigo Faça a gestão do acesso.

Conceda as seguintes funções de IAM à conta de serviço que quer usar para o acionador de webhook:

• Application Integration Invoker (roles/integrations.integrationInvoker)

Para obter informações sobre a atribuição de funções a uma conta de serviço, consulte o artigo Faça a gestão do acesso às contas de serviço.

Adicione o acionador de webhook

Para adicionar um acionador de webhook à sua integração, siga estes passos:

1. Na Google Cloud consola, aceda à página Application Integration.

   Aceda à solução Application Integration

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

   A página Lista de integrações é apresentada com 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 estiver a criar uma nova integração:

   1. Introduza um nome e uma descrição no painel Criar integração.
   2. Selecione uma região para a integração.
      Nota: o menu pendente Regiões apenas apresenta as regiões aprovisionadas no seu projeto do Google Cloud. Para aprovisionar uma nova região, clique em Ativar região. Consulte o artigo Ative uma nova região para mais informações.
   3. Selecione uma conta de serviço para a integração. Pode alterar ou atualizar os detalhes da conta de serviço de uma integração em qualquer altura no painel Resumo da integração na barra de ferramentas de integração.
      Nota: a opção para selecionar uma conta de serviço é apresentada apenas se tiver ativado a gestão da integração para a região selecionada.
   4. Clique em Criar.

   A integração recém-criada é aberta no editor de integração.

4. Na barra de navegação do editor de integração, clique em Acionadores para ver a lista de acionadores disponíveis.
5. Clique e coloque o elemento Acionador de webhook no editor de integração.

Para configurar o Acionador de webhook, pode usar uma ligação de webhook existente disponível nos Integration Connectors ou criar uma nova ligação de webhook através da opção de criação de ligações inline.

Configure o acionador de webhook através de uma associação existente

Pode configurar o acionador de webhook através de uma ligação de webhook existente nos Integration Connectors. Tenha em atenção que o acionador de webhook é um acionador de eventos de conector. Por conseguinte, só pode usar uma ligação de webhook com a subscrição de eventos ativada para configurar o acionador.

Para obter informações sobre como configurar um acionador de webhook através de uma nova ligação de webhook, consulte o artigo Configure o acionador de webhook através de uma nova ligação

Para configurar um acionador de webhook através de uma ligação de webhook existente, siga estes passos:

1. Clique no elemento Acionador de webhook no editor de integração para abrir o painel de configuração do acionador.
2. Clique em Configurar acionador.
3. Forneça os seguintes detalhes de configuração na página Editor do acionador de eventos do conetor:
   1. Região: selecione a região da sua ligação de webhook.
   2. Ligação: selecione a ligação Webhook que quer usar.

      A integração de aplicações só apresenta as ligações de webhook que estão ativas e têm uma subscrição de eventos ativada.

   3. Tipo de subscrição de eventos: introduza o tipo de evento que quer usar para acionar a integração.
   4. Conta de serviço: selecione uma conta de serviço com as funções do IAM necessárias para o acionador de webhook.
4. Clique em Concluído para concluir a configuração do acionador e fechar a página.

Para mais informações, consulte a documentação sobre a ligação de webhook.

Configure o acionador de webhook com uma nova ligação

Para configurar o Webhook trigger através de uma nova ligação Webhook, siga estes passos:

1. Clique no elemento Acionador de webhook no editor de integração para abrir o painel de configuração do acionador.
2. Clique em Configurar acionador.
3. Ignore o campo Região.
4. Clique em Ligação e selecione a opção Criar ligação no menu.
5. Conclua os seguintes passos no painel Criar associação:
   1. Na secção Localização, escolha a localização para a ligação.
      1. Região: selecione uma localização na lista.

         As regiões suportadas para conetores incluem:

         Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

      2. Clicar em Seguinte.
   2. Na secção Detalhes da associação, conclua o seguinte:
      1. Conector: selecione Webhook na lista pendente de conectores disponíveis.
      2. Versão do conector: selecione a versão do conector na lista pendente de versões disponíveis.
      3. Nome da associação: introduza um nome para a instância da associação.

         Os nomes das associações têm de cumprir os seguintes critérios:

         • Os nomes das associações podem usar letras, números ou hífenes.
         • As letras têm de ser minúsculas.
         • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
         • Os nomes das associações não podem exceder 49 carateres.
         • Para os conetores que suportam a subscrição de eventos, os nomes das associações não podem começar com o prefixo "goog".
      4. Descrição: opcionalmente, introduza uma descrição para a instância de associação.
      5. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
      6. Subscrição de eventos: a subscrição de eventos está ativada por predefinição e é obrigatória para o conetor de webhook.
         Nota: a opção Enable event subscription, entity and actions não é suportada para esta associação.
      7. Opcionalmente, clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
      8. Clicar em Seguinte.
   3. Na secção Detalhes da subscrição de eventos, conclua o seguinte:
      1. Autenticação do ouvinte: selecione um tipo de autenticação para o ouvinte de eventos e introduza os detalhes relevantes.

         Os seguintes tipos de autenticação são suportados pelo ouvinte de webhook:

         • Sem autenticação
         • Autenticação Google: certifique-se de que a conta de serviço tem a função roles/connectors.listener cujo token de acesso é usado para autenticação.
         • Autenticação de chaves da API
         • Autenticação básica
      2. Localização do campo de tipo de evento: campo obrigatório que indica a localização (cabeçalho, parâmetro de consulta ou corpo do pedido) onde o tipo de evento associado ao pedido de evento recebido vai estar presente.
      3. Nome do campo do tipo de evento: o campo obrigatório na localização configurada identifica o tipo de evento associado ao pedido de evento recebido.

      {
      "event_type": "user.created",
      ...
      // other request fields
      ...
      }

      No exemplo acima, o campo event_type no corpo do pedido significa que o pedido se refere a um evento "user.created".
      4. Selecione Ativar conetividade privada para uma conetividade segura entre a sua aplicação de back-end e a sua ligação. Se selecionar esta opção, tem de realizar passos de configuração adicionais depois de criar a associação. Para mais informações, consulte o artigo Conetividade privada para subscrição de eventos.
      5. Introduza a configuração de mensagens não entregues. Se configurar a fila de mensagens rejeitadas, a ligação escreve os eventos não processados no tópico Pub/Sub especificado. Introduza os seguintes detalhes:
         1. ID do projeto de mensagens não entregues: o ID do projeto do Google Cloud onde configurou o tópico Pub/Sub de mensagens não entregues.
         2. Tópico de mensagens não entregues: o tópico do Pub/Sub onde quer escrever os detalhes do evento não processado.
      6. Clicar em Seguinte.
   4. Rever: reveja os detalhes de autenticação da ligação e do ouvinte.
   5. Clique em Criar.

Saída do acionador

O acionador de webhook demora alguns minutos a concluir a configuração da subscrição de eventos. Pode ver o estado da subscrição de eventos no painel de configuração do acionador em Detalhes da subscrição de eventos.

O acionador de webhook indica o estado de uma subscrição de eventos através dos seguintes estados:

• Creating: indica que o acionador está a subscrever a subscrição de eventos.
• Active: indica que o acionador subscreveu com êxito uma subscrição de eventos.
• Error: indica que existe um problema com a subscrição de eventos configurada.

Além do estado da subscrição de eventos, a secção Detalhes da subscrição de eventos também apresenta outros detalhes, como a região da associação, o nome da associação, o nome da subscrição de eventos e muito mais.

Variável de saída do acionador

Para cada evento, o acionador de webhook gera uma variável de saída ConnectorEventPayload que pode usar nas tarefas posteriores. A variável de saída está no formato JSON e contém o esquema do payload do Webhook de saída. O acionador de webhook só aceita payloads JSON.

Veja as subscrições de eventos

Para ver e gerir todas as subscrições de eventos associadas a uma ligação nos Integration Connectors, faça o seguinte:

1. Aceda à página Integration Connectors > Ligações.

   Aceda à página Ligações

2. Clique na associação para a qual quer ver as subscrições.
3. Clique no separador Subscrições de eventos.

   Esta apresenta todas as subscrições de eventos da associação.

Editar acionador de webhook

Pode editar um Acionador de webhook para alterar ou atualizar a configuração da ligação e os detalhes da subscrição de eventos.

Importante: quando edita ou modifica um acionador de webhook, pode manter a subscrição de eventos configurada anteriormente que está anexada ao acionador ou pode eliminá-la. A eliminação de uma subscrição de eventos afeta todas as integrações publicadas que usam essa subscrição de eventos.

Para editar um acionador de webhook, siga estes passos:

1. Clique no elemento Acionador de webhook no editor de integração para abrir o painel de configuração do acionador.
2. Clique em Configurar acionador de webhook.
3. Faça o seguinte na página Editor de acionadores de eventos do conetor:
   1. Para manter a subscrição de eventos configurada anteriormente, clique em Manter. Caso contrário, clique em Eliminar.
      Aviso: a eliminação de uma subscrição de eventos afeta todas as integrações publicadas que usam a subscrição de eventos. Não é possível anular esta tarefa.
   2. Atualize a configuração da associação e os detalhes da subscrição de eventos conforme pretendido.
   3. Clique em Concluído.

Pode ver os detalhes atualizados da associação e da subscrição de eventos no painel de configuração do acionador em Detalhes da subscrição de eventos.

Quotas e limites

Para informações sobre quotas e limites, consulte o artigo Quotas e limites.

O que se segue?

• Saiba mais sobre todas as tarefas e acionadores.
• Saiba como testar e publicar uma integração.
• Saiba mais acerca do processamento de erros.
• Saiba mais sobre os registos de execução da integração.