Consulte os conectores compatíveis com o Application Integration.

Gatilho de webhook

O gatilho de webhook é um gatilho de evento do conector que permite invocar uma integração com base em qualquer evento do back-end que ofereça suporte a webhooks. O gatilho de webhook recebe eventos de aplicativos SaaS de terceiros que oferecem suporte à capacidade de eventos de webhook. Esse gatilho aceita vários tipos de autenticação para seu listener de eventos e apenas payloads JSON.

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 mais informações sobre como conceder papéis, consulte Gerenciar o 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 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.

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

    1. Digite 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. É possível 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 de integração.
    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 conferir a lista de acionadores disponíveis.
  5. Clique e coloque o elemento Gatilho de webhook no editor de integração.

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

Configurar o gatilho de webhook usando uma conexão atual

É possível configurar o gatilho de webhook usando uma conexão de webhook atual no Integration Connectors. O gatilho de webhook é um gatilho de evento do conector. Portanto, só é possível usar uma conexão de webhook com a inscrição em 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 um 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 gatilho de webhook no editor de integração para abrir o painel de configuração do gatilho.
  2. Clique em Configurar acionador.
  3. Forneça 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 de webhook.
    2. Conexão:selecione a conexão de webhook que você quer usar.

      Application Integration mostra apenas as conexões de webhook ativas e com 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 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 gatilho de webhook usando uma nova conexão 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 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 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: 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 aceitam inscrição em eventos, os nomes de conexão não podem começar com o prefixo "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 evento: a assinatura de evento é ativada por padrão e é obrigatória para o conector de webhook.
      7. Outra opção é 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 de 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.

        O listener de webhook é compatível com os seguintes tipos de autenticação:

      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 vai 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 se refere a um evento "user.created".
      4. Selecione Ativar conectividade particular para uma conectividade segura entre o aplicativo de back-end e a conexão. Se você selecionar essa opção, precisará 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 inativas. Se você configurar a carta 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 dead-letter : o ID do projeto do Google Cloud em que você configurou o tópico de dead-letter do Pub/Sub.
        2. Tópico de mensagens mortas : 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 assinatura de evento. É possível conferir o status da sua inscrição em eventos no painel de configuração do gatilho, em Detalhes da inscrição em eventos.

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

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

Além do status da inscrição no evento, a seção Detalhes da inscrição no evento também mostra outros detalhes, como região e nome da conexão, nome da inscrição no 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 e contém o esquema de payload do webhook de saída. O gatilho de webhook aceita apenas payloads JSON.

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 a página Integration Connectors > Conexões.

    Acessar a página "Conexões"

  2. Clique na conexão para ver as assinaturas.
  3. Clique na guia Assinaturas de eventos.

    Isso mostra todas as inscrições em eventos da conexão.

Editar gatilho de webhook

É possível editar um gatilho de webhook para mudar ou atualizar a configuração de conexão e os detalhes de inscrição no evento.

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 acionador de webhook.
  3. Faça o seguinte na página Editor de gatilho de evento do conector:
    1. Para manter a assinatura de evento configurada anteriormente, clique em Manter. Caso contrário, clique em Excluir.
    2. Atualize a configuração de conexão e os detalhes da inscrição no evento conforme necessário.
    3. Clique em Concluído.

    4. Você pode conferir os detalhes atualizados da conexão e da assinatura de evento no painel de configuração do gatilho em Detalhes da assinatura de evento.

Cotas e limites

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

A seguir