Consulte os conectores compatíveis com a integração de aplicativos.

Acionador 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 do back-end compatível com webhooks. O acionador de webhook recebe eventos de aplicativos de terceiros baseados em SaaS que oferecem suporte a eventos de webhook. Esse gatilho oferece suporte a vários tipos de autenticação para seu listener de eventos.

Importante:os Integration Connectors são um componente faturável do Google Cloud. Para informações sobre os custos e as cobranças do uso do Integration Connectors, consulte 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 do conector (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 acionador de webhook à 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 com todas as integrações disponíveis no projeto do Google Cloud.

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

   Caso você esteja criando uma nova integração, siga estas etapas:

   1. Insira um nome e uma descrição no painel Criar integração.
   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 da integração.
      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 para a 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 acionadores 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 disponível no Integration Connectors ou crie uma nova conexão de webhook usando a opção de criação de conexão inline.

Configurar o acionador do webhook usando uma conexão existente

É possível configurar o gatilho de webhook usando uma conexão de webhook existente nos Integration Connectors. O gatilho de webhook é um gatilho de evento do conector. Portanto, só é possível usar uma conexão de webhook com a assinatura de eventos ativada para configurar o gatilho.

Para saber como configurar um gatilho de webhook usando uma nova conexão, consulte Configurar o gatilho de webhook usando uma nova conexão.

Para configurar um gatilho de webhook usando uma conexão de webhook existente, siga estas etapas:

1. Clique no elemento Webhook trigger no editor de integração para abrir o painel de configuração do gatilho.
2. Clique em Configurar acionador.
3. Informe os seguintes detalhes de configuração na página Editor de 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 integração de aplicativos só mostra as conexões de webhook que estão ativas e têm uma assinatura de evento 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 acionador do 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 Conexão de webhook.

Configurar o acionador de webhook usando uma nova conexão

Para configurar o gatilho de webhook usando uma nova conexão, siga estas etapas:

1. Clique no elemento Webhook trigger no editor de integração para abrir o painel de configuração do gatilho.
2. Clique em Configurar acionador.
3. Ignore o campo Região.
4. Clique em Conexão e selecione a opção Criar conexão no menu.
5. Conclua as seguintes 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 compatíveis com o conector:

         Para conferir 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 ter mais de 49 caracteres.
         • Nos conectores que oferecem suporte a assinaturas de eventos, os nomes das conexões não podem começar com "goog". .
      4. Descrição: se quiser, 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 de 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 adicionar um rótulo à conexão na forma de um par de chave-valor.
      8. Clique em Próxima.
   3. Na seção Detalhes da assinatura do evento, 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 e seu token de acesso é usado para autenticação.
         • Autenticação de chave de API
         • Autenticação básica
      2. Local do campo do 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.

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

      No exemplo acima, o campo event_type em corpo da solicitação indica que a solicitação pertence a um evento "user.created".
      4. Selecione Ativar conectividade privada para conectividade segura entre seu aplicativo de back-end e sua conexão. Se você selecionar essa opção, será necessário realizar outras etapas de configuração depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinaturas de eventos.
      5. Insira a configuração de mensagens inativas. Se você configurar mensagens inativas, a conexão gravará os eventos não processados para o tópico do Pub/Sub especificado. Digite os seguintes detalhes:
         1. ID do projeto de caixa de destino: o ID do projeto do Google Cloud em que você configurou o tópico de caixa de destino do Pub/Sub.
         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.
   4. Revisão: revise os detalhes de conexão e autenticação 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 do evento. É possível conferir o status da assinatura do evento no painel de configuração do acionador em Detalhes da assinatura do evento.

O gatilho de webhook indica o status de uma assinatura de evento usando os seguintes estados:

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

Além do status da assinatura do evento, a seção Detalhes da assinatura do evento também mostra outros detalhes, como região de conexão, nome da conexão, nome da assinatura do evento e muito mais.

Variável de saída do acionador

Para cada evento, o gatilho de 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 com o esquema de payload do webhook de saída.

Ver inscrições em eventos

Para conferir e gerenciar todas as assinaturas de eventos associadas a uma conexão nos Conectores de integração, faça o seguinte:

1. Acesse a página Integration Connectors > Conexões.

   Acessar a página "Conexões"

2. Clique na conexão que tem as assinaturas que você quer conferir.
3. Clique na guia Assinaturas de eventos.

   Isso exibe todas as inscrições de eventos da conexão.

Editar gatilho de webhook

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

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

Para editar um gatilho de webhook, siga estas etapas:

1. Clique no elemento Webhook trigger no editor de integração para abrir o painel de configuração do acionador.
2. Clique em Configurar gatilho de webhook.
3. Faça o seguinte na página Editor do acionador de evento do conector:
   1. Para manter a assinatura de evento configurada anteriormente, clique em Manter. Caso contrário, clique em Excluir.
      Aviso:a exclusão de uma assinatura de evento vai afetar 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 de inscrição no evento conforme desejado.
   3. Clique em Concluído.

É possível conferir os detalhes atualizados da conexão e da assinatura de eventos no painel de configuração do acionador em Detalhes da assinatura de eventos.

Cotas e limites

Para informações sobre o assunto, consulte Cotas e limites.

A seguir

• Saiba mais sobre todas as tarefas e acionadores.
• Saiba como testar e publicar uma integração.
• Saiba mais sobre o tratamento de erros.
• Saiba mais sobre os registros de execução de integração.