HTTP Webhook authentication

Pré-requisitos

Your webhook provider may require a handshake. Refer to the Webhook challenge verification section for details on how to configure the challenge verification.

Depending on where you create the trigger, the generated webhook URL will appear either in the HTTP Webhook trigger activity or on the trigger creation page, but only after the connection is created successfully. To avoid failures, paste the webhook URL into your application after you publish your workflow or the trigger is successfully created in UiPath Orchestrator.

Criação de uma conexão HTTP Webhook

1. Selecione Integration Service no menu de navegação esquerdo.
2. From the Connectors list, select HTTP Webhook. You can also use the search bar to find the connector.
3. Selecione Conectar ao HTTP Webhook.
4. No campo Para qual aplicativo é esse webhook , insira um nome descritivo para o aplicativo de webhook, algo que facilita a identificação de qual fornecedor ou integração essa conexão representa. Esse valor se torna o Identificador de conexão.
5. Configure o local do desafio
   Choose how the vendor will send the challenge token so that UiPath can respond correctly:
   • No challenge - the vendor does not require a handshake, and you can proceed to connect.
   • Parâmetro de consulta (por exemplo, ?challenge=...)
   • Corpo JSON ( POST com { "challenge": "..." })
   • Cabeçalho (por exemplo, X-Hub-Challenge)
6. Configure a verificação de desafio e conecte-se
   If the vendor requires a handshake, enter the challenge verification that matches the vendor's pattern (which field/header/query to read and how to echo/validate it). When configuration is complete, click Connect.

Dica:

• Use um nome que inclua o fornecedor e o ambiente (por exemplo, Stripe-prod ou Slack-staging) para evitar confusão.
• Se você não tiver certeza de qual padrão de desafio o fornecedor usa, verifique seus documentos do webhook ou execute um registro de teste para inspecionar a solicitação de handshake.

Verificação do desafio do Webhook

Alguns fornecedores exigem que os URLs do webhook sejam validados antes de começarem a enviar eventos reais. Isso é feito usando um mecanismo de desafio-resposta. Quando você registra um webhook, o fornecedor envia uma solicitação de desafio especial, e o ponto de extremidade deve responder exatamente conforme o esperado.

O conector HTTP Webhook é compatível com esses fluxos de verificação por meio do Framework de Desafios do Webhook, permitindo que você configure como a UiPath deve ler e responder aos desafios do fornecedor.

Suporte à verificação de desafio

A UiPath é compatível com ambos os tipos de comportamentos de webhook de fornecedor:

• Fornecedores que não usam a verificação de desafio
• Fornecedores que exigem um handshake antes de ativar o webhook

Isso garante compatibilidade com provedores de webhooks simples, bem como aqueles com requisitos de segurança mais avançados.

Quando os fornecedores não usam a verificação de desafio

Muitos aplicativos simplesmente aceitam um URL de webhook e começam a fornecer eventos imediatamente.
Para estes fornecedores:

• Os usuários só precisam criar ou selecionar uma conexão.
• Copie o URL do webhook.
• Cole-o na configuração do webhook do fornecedor.

Nenhuma etapa adicional é necessária. O webhook fica ativo assim que o fornecedor começa a enviar eventos.

Esse é o cenário mais comum e mais simples, e a UiPath lida com isso perfeitamente.

Quando os fornecedores exigem a verificação de desafio

Alguns fornecedores enviam uma solicitação de desafio para verificar o URL do webhook antes de habilitá-lo.
Nestes casos:

• Os usuários devem configurar a resposta do desafio na conexão HTTP do Webhook.
• A UiPath escuta a solicitação de desafio do fornecedor.
• A UiPath retorna automaticamente o valor de desafio correto com base na configuração.
• Depois que o fornecedor valida a resposta, os eventos normais começam a fluir.

Como os fornecedores diferem na forma como enviam o desafio (parâmetro de consulta, corpo JSON, cabeçalho etc.), a configuração da UiPath permite que os usuários lidem com qualquer um desses padrões.

Isso garante compatibilidade com provedores de webhook que impõem handshakes de segurança, como Slack, Meta (Facebook/Instagram), Stripe e outros.

Configurando a verificação de desafio

Você configura o comportamento desafio usando quatro parâmetros:

• Chave do Desafio
  Campo/chave que contém o valor do desafio. Usado para detectar solicitações de desafio (não deve ser nulo).

• Local do Desafio
  Onde a chave aparece:

  • Corpo
  • Parâmetro de consulta
  • Cabeçalho

• Tipo de conteúdo da resposta ao desafio
  Formato da resposta retornada ao fornecedor:

  • texto/simples
  • application/json

• Formato da Resposta do Desafio
  Define qual valor é retornado (em geral a própria chave de desafio).
  A UiPath extrai o valor do desafio que recebe e responde de acordo.

Exemplo genérico

Solicitação de entrada

 {
  "challenge": "ABC123"
 }

Configuração

• Chave do Desafio: challenge != null
• Local do desafio: corpo
• ResponseType: text/plain
• Formato da Resposta: challenge

Resposta

ABC123

Exemplo de verificação de desafio do WhatsApp

O WhatsApp usa o método de desafio baseado em parâmetro de consulta com hub.challenge.

Configuração

Parâmetro	Valor
Chave do Desafio	hub.challenge != null
Local do Desafio	Parâmetro de consulta
Tipo de conteúdo da resposta ao desafio	text/plain
Formato da Resposta do Desafio	hub.challenge

Solicitação do fornecedor

GET https://your-webhook-url?hub.challenge=1234567890

Resposta esperada da UiPath

HTTP/1.1 200 OK
Content-Type: text/plain

1234567890

Isso confirma a propriedade, e o WhatsApp começa a enviar eventos de webhook reais em seguida.

Resumo — Genérico vs WhatsApp

Etapa	Exemplo Genérico	Exemplo do WhatsApp
Local do Desafio	Corpo/Consulta/Cabeçalho	Consulta
FormatoDaChave	Chave simples (por exemplo, challenge)	Chave com ponto "hub.challenge")
ResponseType	texto/simples ou aplicativo/json	texto/simples
Valor da Resposta	Valor da chave	Valor de "hub.challenge"
Método	POST ou GET	Apenas GET