HTTP Webhook authentication

Prérequis

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.

Création d'une connexion HTTP Webhook

1. Sélectionnez Integration Service dans la barre de gauche.
2. From the Connectors list, select HTTP Webhook. You can also use the search bar to find the connector.
3. Sélectionnez Se connecter à HTTP Webhook.
4. Dans le champ Pour quelle application est ce Webhook , saisissez un nom descriptif pour l’application de Webhook, quelque chose qui facilite l’identification du fournisseur ou de l’intégration que cette connexion représente. Cette valeur devient l' identificateur de connexion.
5. Configurer l'emplacement du défi
   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.
   • Paramètre de requête (par exemple, ?challenge=...)
   • Corps JSON (PUBLIER avec { "challenge": "..." })
   • En-tête (par ex., X-Hub-Challenge)
6. Configurer la vérification du défi et se connecter
   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.

Astuce :

• Utilisez un nom qui inclut le fournisseur et l’environnement (par exemple, Stripe-prod ou Slack-staging) pour éviter toute confusion.
• Si vous ne savez pas quel modèle de défi le fournisseur utilise, vérifiez les documents de son webhook ou exécutez un enregistrement de test pour inspecter la demande d'établissement de liaison.

Vérification du défi de webhook

Certains fournisseurs exigent que les URL du webhook soient validées avant de commencer à envoyer des événements réels. Cela se fait à l'aide d'un mécanisme de défi-réponse. Lorsque vous enregistrez un webhook, le fournisseur envoie une demande de défi spécial et le point de terminaison doit répondre exactement comme prévu.

Le connecteur HTTP Webhook prend en charge ces flux de vérification via l' infrastructure des défis Webhook, vous permettant de configurer la façon dont UiPath doit lire et répondre aux défis des fournisseurs.

Prise en charge de la vérification des défis

UiPath prend en charge les deux types de comportements Webhooks des fournisseurs :

• Fournisseurs qui n’utilisent pas la vérification des défis
• Les fournisseurs qui ont besoin d’établir une liaison de défi avant d’activer le Webhook

Cela garantit la compatibilité avec les fournisseurs de webhooks simples ainsi que ceux avec des exigences de sécurité plus avancées.

Lorsque les fournisseurs n'utilisent pas la vérification des défis

De nombreuses applications acceptent simplement une URL de webhook et commencent immédiatement à fournir des événements.
Pour ces fournisseurs :

• Les utilisateurs n'ont qu'à créer ou sélectionner une connexion.
• Copiez l’ URL du webhook.
• Collez-le dans la configuration du webhook du fournisseur.

Aucune étape supplémentaire n'est nécessaire. Le Webhook devient actif dès que le fournisseur commence à envoyer des événements.

Il s'agit du scénario le plus courant et le plus simple, et UiPath le gère de manière transparente.

Lorsque les fournisseurs ont besoin de vérification des difficultés

Certains fournisseurs envoient une requête de défi pour vérifier l’URL du webhook avant de l’activer.
Dans ces cas :

• Les utilisateurs doivent configurer la réponse au défi dans la connexion HTTP Webhook.
• UiPath écoute la demande de défi du fournisseur.
• UiPath renvoie automatiquement la valeur de défi correcte en fonction de la configuration.
• Une fois que le fournisseur a validé la réponse, les événements normaux commencent à se produire.

Étant donné que les fournisseurs diffèrent dans la façon dont ils envoient le défi (paramètre de requête, corps JSON, en-tête, etc.), la configuration de UiPath permet aux utilisateurs de gérer n'importe lequel de ces modèles.

Cela garantit la compatibilité avec les fournisseurs de Webhooks qui appliquent les liaisons de sécurité tels que Slack, Meta (Facebook/Instangram), Stripe et autres.

Configurer la vérification des défis

Vous pouvez configurer le comportement au défi à l'aide de quatre paramètres :

• Clé de défi
  Champ/clé contenant la valeur du défi. Utilisé pour détecter les requêtes de défi.

• Emplacement du défi
  Où la clé apparaît :

  • Corps
  • Paramètre de requête
  • En-tête

• Type de contenu de réponse de défi
  Format de la réponse renvoyée au fournisseur :

  • texte/Brute
  • application/json

• Format de réponse de défi
  Définit la valeur renvoyée (en général la clé de défi elle-même).
  UiPath extrait la valeur du défi entrant et répond en conséquence.

Exemple générique

Demande entrante

 {
  "challenge": "ABC123"
 }

Configuration

• Clé de défi : challenge != null
• Emplacement du défi : Corps
• Type de réponse : text/plain
• Format de réponse : challenge

Réponse

ABC123

Exemple de vérification de défi Whatsapp

WhatsApp utilise la méthode de défi basée sur les paramètres de requête avec hub.challenge.

Configuration

Paramètre	Valeur (Value)
Clé de défi	hub.challenge != null
Emplacement du défi	Paramètre de requête
Type de contenu de réponse de défi	text/plain
Format de réponse de défi	hub.challenge

Demande du fournisseur

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

Réponse attendue d’UiPath

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

1234567890

Cela confirme la propriété et WhatsApp commencera par la suite à envoyer de vrais événements de webhook.

Résumé — Générique et Whatsapp

Étape	Exemple générique	Exemple de Whatsapp
Emplacement du défi	Corps/Requête/En-tête	Requête
Format de clé	Clé simple (par exemple, challenge)	Clé avec un point "hub.challenge")
ResponseType	texte/IA ou application/json	texte/Brute
Valeur de la réponse	Valeur de la clé	Valeur de "hub.challenge"
Method	POST ou GET	OBTENIR uniquement