Webhook

O conector de webhook permite-lhe ouvir eventos do seu back-end que suporta webhooks. Este conetor foi concebido para ser usado com o acionador de webhook. 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 seu ouvinte de eventos. Para usar o acionador de webhook na sua integração, tem de configurar primeiro um conector de webhook.

Antes de começar

Antes de usar o conector Webhook, conclua as seguintes tarefas:

  • No seu projeto do Google Cloud:
    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (API Connectors)

      Para saber como ativar serviços, consulte o artigo Ativar serviços.

    • Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.

    Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

  1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

    Aceda à página Ligações

  2. Clique em + Criar novo para abrir a página Criar associação.
  3. Na secção Localização, escolha a localização para a ligação.
    1. Região: selecione uma localização na lista pendente.

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

    2. Clicar em Seguinte.
  4. 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.
    7. Opcionalmente, clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
    8. Clicar em Seguinte.
  5. 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:

    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.
      4. {
"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.
  6. Rever: reveja os detalhes de autenticação da ligação e do ouvinte.
  7. Clique em Criar.

Use a ligação de webhook numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

  • Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
  • Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?