Consulte os conectores compatíveis com o Application Integration.

Gatilho de webhook

O gatilho de webhook é um gatilho de evento de conector que permite invocar uma integração com base em qualquer evento do back-end compatível com webhooks. O gatilho de webhook recebe eventos de aplicativos baseados em SaaS de terceiros compatíveis com o recurso de eventos de webhook. Esse gatilho oferece suporte a vários tipos de autenticação para seu listener de eventos.

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 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 Integrations.

    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 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.
    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.
    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.

    6. 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 gatilho de webhook usando uma conexão atual

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

Para informações sobre como configurar um gatilho de webhook usando uma nova conexão de Webhook, consulte Configurar gatilho de Webhook usando uma nova conexão

Para configurar um acionador de webhook usando uma conexão de webhook atual, 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 conexão do webhook.
    2. Conexão:selecione a conexão de webhook que você quer usar.

      A Application Integration exibe apenas as conexões Webhook que estão ativas e têm uma assinatura 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 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 gatilho de webhook usando uma nova conexão

Para configurar o acionador de webhook usando uma nova conexão 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.
  3. Ignore o campo Região.
  4. Clique em Conexão e selecione a opção Criar conexão no menu.
  5. Conclua as etapas a seguir 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 exceder 63 caracteres.
      4. Descrição: insira uma descrição para a instância de conexão, se quiser.
      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.
      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:

      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 do 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 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 assinatura 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 mensagens inativas: o ID do projeto do Google Cloud em que você configurou o tópico de mensagens inativas 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 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 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 acionador de webhook indica o status de uma assinatura de evento usando os seguintes estados:

  • Creating: indica que o acionador está fazendo a assinatura da 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 exibe outros detalhes, como região da 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 visualizar e gerenciar todas as assinaturas de eventos associadas a uma conexão no Integration Connectors, faça o seguinte:

  1. Acesse 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 Inscrições de eventos.

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

Editar gatilho de webhook

É possível editar um gatilho de webhook para mudar ou atualizar a configuração da conexão e os detalhes da assinatura de eventos.

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 gatilho.
  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 eventos configurada anteriormente, clique em Reter. Caso contrário, clique em Excluir.
    2. Atualize a configuração da conexão e os detalhes de inscrição no evento conforme desejado.
    3. Clique em Concluído.

    4. É 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