Sobre o conector HTTP Webhook

Configure o conector HTTP Webhook no Integration Service para receber retornos de chamada em tempo real e orientados por eventos de aplicativos externos sem pesquisa.

Webhooks permitem que aplicativos notifiquem sistemas externos em tempo real, reduzindo a necessidade de pesquisas frequentes e minimizando chamadas de API. Em vez de verificar periodicamente atualizações, o sistema recebe retornos de chamada baseados em eventos apenas quando ocorrem alterações relevantes.

O conector UiPath HTTP Webhook permite que você dispare fluxos de trabalho diretamente de aplicativos de fornecedor. Você pode criar gatilhos instantâneos para eventos para qualquer aplicativo de terceiros que suporte notificações de webhook de saída, mesmo que não faça parte do catálogo de conectores.

Você também pode aplicar filtros de dados de evento para especificar as condições exatas sob as quais um evento de webhook deve disparar um fluxo de trabalho.

Como funciona

O gatilho HTTP Webhook gera uma URL de retorno de chamada pública dinâmica. Copie e configure este URL nas configurações de webhook do aplicativo do fornecedor somente após seu gatilho ter sido criado no Orchestrator.

Quando um evento ocorre no sistema do fornecedor:

1. O fornecedor envia a carga do evento para o URL configurado.
2. O Integration Service recebe a carga e a avalia em relação aos seus filtros de dados de evento configurados.
3. Se uma correspondência for encontrada, o Integration Service disparará a execução do fluxo de trabalho por meio do Orchestrator.

As cargas do Webhook são processadas da mesma maneira que quaisquer outros eventos de gatilho. O conector também é compatível com a autenticação opcional baseada em cabeçalho, que permite que o fornecedor se autentique para a UiPath em cada entrega de webhook usando um valor de cabeçalho configurado.

Para obter mais informações, consulte Usando o conector do Webhook.

Para obter informações sobre como criar uma conexão e configurar a verificação de desafio, se solicitado pelo fornecedor, consulte Autenticação HTTP Webhook.

Segurança

O conector HTTP Webhook oferece dois mecanismos de segurança complementares, ambos configurados no momento da criação da conexão:

Mecanismo	O que faz	Quando usar
Verificação do desafio	Permite que o fornecedor confirme se o URL do seu webhook da UiPath é válido antes de enviar eventos.	Quando o fornecedor requer um handshake (Slack, Meta etc.).
Autenticação Baseada em Cabeçalho	Valida cada solicitação de webhook de entrada usando um segredo compartilhado carregado em um cabeçalho HTTP (por X-API-Key, ). As solicitações que não carregam o valor do cabeçalho configurado são rejeitadas com HTTP 401.	Quando você quer evitar que chamadores não autorizados publiquem na URL do seu webhook e seu fornecedor permite que você configure um cabeçalho personalizado em entregas de webhook de saída.

Para obter detalhes de configuração, consulte Autenticação HTTP Webhook.

Limites de taxa

Os eventos disparados pelo Webhook estão sujeitos aos seguintes limites:

• 500 eventos por minuto por tenant
• 100 eventos por minuto por conexão

Limitações

• A depuração do gatilho do tempo de design não está disponível no momento.
• Apenas solicitações no formato JSON são compatíveis.
• O tamanho máximo da carga de webhook com suporte é de 14 MB. As solicitações que excedem esse limite são rejeitadas e nenhum evento de gatilho é enviado.

Perguntas frequentes

Colei o URL do Webhook na interface gráfica do provedor. Por que a verificação ainda não está sendo aprovada?

A verificação só será bem-sucedida depois que o gatilho for criado no Orchestrator e desde que você tenha configurado o desafio corretamente. Observe que a UiPath não realiza nenhuma verificação de desafio de nosso lado — a validação acontece totalmente no lado do provedor, para estabelecer confiança com o destino.

Configurei o desafio incorretamente. Por que minha conexão ainda está sendo criada com sucesso?

No momento, a UiPath não valida a etapa de desafio/verificação do provedor. Essa validação é tratada inteiramente pelo fornecedor. Como resultado, a conexão no UiPath pode aparecer ativa mesmo se a verificação de desafio do provedor tiver realmente falhado do seu lado.

Como uso a resposta de um webhook criado no Orchestrator?

Use a atividade Get Trigger Event Output em seu fluxo de trabalho e transmita UiPathEventObjectId (data type=Text) como o argumento de entrada. Essa atividade retornará o corpo e os cabeçalhos recebidos do webhook.

A resposta do webhook é uma string JSON. Como uso partes dele no meu fluxo de trabalho?

Use a atividade Deserialize JSON para converter a string em um JObject, após o qual você pode acessar facilmente campos individuais.

Posso exigir que o fornecedor autentique ao enviar eventos de webhook para a UiPath?

Sim. Habilite a autenticação baseada em cabeçalho ao criar ou editar a conexão e, em seguida, configure o cabeçalho correspondente nas configurações do webhook do fornecedor. Para obter instruções de configuração, consulte Autenticação HTTP Webhook.

Meu fornecedor usa seu próprio esquema de assinatura (por exemplo, X-Hub-Signature-256). Ainda posso usar a autenticação baseada em cabeçalho?

Não. A autenticação baseada em cabeçalho usa um valor de cabeçalho estático e pré-compartilhado. Os fornecedores baseados em assinatura calculam um HMAC novo em cada solicitação usando a carga útil e um segredo compartilhado — a UiPath não valida atualmente assinaturas específicas do fornecedor. Para esses fornecedores, os mecanismos de segurança disponíveis são segredo de URL e o handshake de verificação de desafio do fornecedor.