Verwenden des Webhook-Connectors

Verwenden des HTTP Webhook-Connectors von Studio

1. Wählen Sie den HTTP Webhook-Trigger aus

   Wählen Sie in Studio den HTTP Webhook- Trigger aus.

2. Erstellen oder wählen Sie eine Verbindung aus

   Verwenden Sie eine vorhandene Verbindung oder erstellen Sie eine neue.

3. Kopieren Sie die Webhook-URL

   Rufen Sie die generierte Webhook-URL aus der Triggeraktivität ab.

4. Konfigurieren Sie Ihren Datenfilter

   Definieren Sie die Bedingungen, unter denen das Webhook-Ereignis ausgelöst werden soll.

5. Publish your process

   Veröffentlichen Sie den Workflow, damit er ausgelöst werden kann.

6. Registrieren Sie die Webhook-URL in Ihrer Anwendung

   Fügen Sie die kopierte Webhook-URL aus Schritt 3 in die Webhook-Konfiguration Ihrer Anbieteranwendung ein.

Verwenden des HTTP Webhook-Connectors von Orchestrator

1. Wählen Sie in Orchestrator Ereignistrigger öffnen > Neuen Trigger hinzufügen.

2. Wählen Sie Ihren Prozess aus, geben Sie einen Namen an und klicken Sie auf Weiter.

3. Wählen Sie Connector: HTTP-Webhook aus.

4. Erstellen oder wählen Sie eine Verbindung aus.

   Verwenden Sie eine vorhandene Verbindung oder erstellen Sie eine neue. Erfahren Sie, wie Sie Verbindungen erstellen.

5. Konfigurieren Sie Ihren Datenfilter.

   Definieren Sie die Bedingungen, unter denen das Webhook-Ereignis ausgelöst werden soll. Erfahren Sie, wie Sie Datenfilter konfigurieren.

6. Kopieren Sie die Webhook-URL zur späteren Verwendung.

7. Fügen Sie den Trigger hinzu, um das Setup abzuschließen.

8. Verwenden Sie in Ihrem Workflow die Aktivität Get Trigger Event Output, um den Header oder Text des Webhooks zu verwenden.

   Übergeben Sie UiPathEventObjectId (datentyp=Text) als Eingabeargument für die erforderliche Eigenschaft UiPath-Ereignisobjekt-ID.

Erstellen einer HTTP Webhook-Verbindung

1. Benennen Sie die Verbindung
   Geben Sie im Feld Für welche Anwendung ist dieser Webhook ein beschreibender Name für die Webhook-Anwendung ein, um leicht zu identifizieren, welchen Anbieter oder welche Integration diese Verbindung repräsentiert. Dieser Wert wird zum Verbindungsbezeichner.
2. Konfigurieren Sie den Herausforderungsort
   Wählen Sie aus, wie der Anbieter das Herausforderungstoken sendet, damit UiPath korrekt reagieren kann, oder wählen Sie Keine Herausforderung aus . Allgemeine Optionen:
   • Abfrageparameter (z. B. ?challenge=...)
   • JSON-Text (POST mit { "challenge": "..." })
   • Kopfzeile (z. B. X-Hub-Challenge)
3. Konfigurieren Sie die Herausforderungsverifizierung und stellen Sie eine Verbindung her
   Wenn der Anbieter einen Handshake erfordert, geben Sie die Herausforderungskonfiguration ein, die dem Muster des Anbieters entspricht (Welches Feld/Header/Abfrage, der gelesen werden soll und wie es gemacht werden soll/validiert werden soll). Wenn die Konfiguration abgeschlossen ist, klicken Sie auf Verbinden. Hier erfahren Sie mehr über die Herausforderungsverifizierung.

Tipp:

• Verwenden Sie einen Namen, der den Anbieter und die Umgebung enthält (z. B. Stripe-prod oder Slack-staging), um Verwechslungen zu vermeiden.
• Wenn Sie nicht sicher sind, welches Herausforderungsmuster der Anbieter verwendet, überprüfen Sie seine Webhook-Dokumentation oder führen Sie eine Testregistrierung durch, um die Handshake-Anforderung zu überprüfen.

Überprüfung der Webhook-Herausforderung

Einige Anbieter erfordern, dass Webhook-URLs validiert werden, bevor sie mit dem Senden tatsächlicher Ereignisse beginnen. Dies geschieht mithilfe eines Herausforderungs-Antwort-Mechanismus. Wenn Sie einen Webhook registrieren, sendet der Anbieter eine spezielle Herausforderungsanforderung und der Endpunkt muss genau wie erwartet reagieren.

Der HTTP-Webhook-Connector unterstützt diese Verifizierungsabläufe über das Webhook-Herausforderungs-Framework, sodass Sie konfigurieren können, wie UiPath die Herausforderungen von Anbietern lesen und darauf reagieren soll.

Unterstützung der Herausforderungsverifizierung

UiPath unterstützt beide Arten von Webhook-Verhalten des Anbieters:

• Anbieter, die keine Herausforderungsverifizierung verwenden
• Anbieter, die vor der Aktivierung des Webhooks einen Herausforderungs-Handshake erfordern

Dies gewährleistet die Kompatibilität mit einfachen Webhook-Anbietern sowie mit Anbietern mit erweiterten Sicherheitsanforderungen.

Wenn Anbieter keine Herausforderungsverifizierung verwenden

Viele Anwendungen akzeptieren einfach eine Webhook-URL und beginnen sofort mit der Bereitstellung von Ereignissen.
Für diese Anbieter:

• Benutzer müssen lediglich eine Verbindung erstellen oder auswählen.
• Kopieren Sie die Webhook-URL.
• Fügen Sie ihn in die Webhook-Konfiguration des Anbieters ein.

Es sind keine zusätzlichen Schritte erforderlich. Der Webhook wird aktiv, sobald der Anbieter mit dem Senden von Ereignissen beginnt.

Das ist das häufigste und einfachste Szenario, das von UiPath nahtlos behandelt wird.

Wenn Anbieter eine Herausforderungsverifizierung erfordern

Einige Anbieter senden eine Herausforderungsanforderung , um die Webhook-URL zu überprüfen, bevor sie aktiviert werden.
In diesen Fällen:

• Benutzer müssen die Herausforderungsantwort in der HTTP Webhook-Verbindung konfigurieren .
• UiPath wartet auf die Herausforderungsanforderung des Anbieters.
• UiPath gibt basierend auf der Konfiguration automatisch den richtigen Herausforderungswert zurück.
• Sobald der Anbieter die Antwort validiert hat, beginnen normale Ereignisse zu fließen.

Da sich die Anbieter darin unterscheiden, wie sie die Herausforderung senden (Abfrageparameter, JSON-Text, Header usw.), ermöglicht die Konfiguration von UiPath den Benutzern, jedes dieser Muster zu verarbeiten.

Dies gewährleistet die Kompatibilität mit Webhook-Anbietern, die Sicherheits-Handshakes erzwingen, z. B. Slack, Meta (Facebook/Instagram), Stripe und anderen.

Konfigurieren der Herausforderungsverifizierung

Sie konfigurieren das Herausforderungsverhalten mit vier Parametern:

• Herausforderungsschlüssel
  Feld/Schlüssel mit dem Herausforderungswert. Wird zum Erkennen von Herausforderungsanforderungen verwendet ( darf nicht NULL sein).

• Herausforderungsort
  Wo der Schlüssel angezeigt wird:

  • Text
  • Abfrageparameter
  • Kopfzeile

• Inhaltstyp der Herausforderungsantwort
  Format der Antwort, die an den Anbieter zurückgegeben wird:

  • Text/Nur
  • application/json

• Antwortformat der Herausforderung
  Definiert, welcher Wert zurückgegeben wird (in der Regel der Herausforderungsschlüssel selbst).
  UiPath extrahiert den Wert aus der eingehenden Herausforderung und reagiert entsprechend.

Allgemeines Beispiel

Eingehende Anforderung

 {
  "challenge": "ABC123"
 }

Konfiguration

• Herausforderungsschlüssel: challenge != null
• Herausforderungsort: Textkörper
• Antworttyp: text/plain
• Antwortformat: challenge

Antwort

ABC123

Beispiel für die WhatsApp-Herausforderungsverifizierung

WhatsApp verwendet die abfrageparameterbasierte Herausforderungsmethode mit Hub.herausforderung.

Konfiguration

Parameter	Wert
Herausforderungsschlüssel	hub.challenge != null
Herausforderungsort	Abfrageparameter
Inhaltstyp der Herausforderungsantwort	text/plain
Antwortformat der Herausforderung	hub.challenge

Anbieteranfrage

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

Erwartete UiPath-Antwort

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

1234567890

Dadurch wird der Besitz bestätigt und WhatsApp beginnt anschließend, echte Webhook-Ereignisse zu senden.

Zusammenfassung – Generisch im Vergleich zu WhatsApp

Schritt	Allgemeines Beispiel	WhatsApp-Beispiel
Herausforderungsort	Textkörper/Abfrage/Header	Abfrage
Tastenformat	Einfacher Schlüssel (z. B. challenge)	Schlüssel mit Punkt (hub.challenge )
ResponseType	text/nur oder application/json	Text/Nur
Antwortwert	Wert des Schlüssels	Wert von „ hub.challenge “
Method	POST oder GET	Nur GET

Konfigurieren von Datenfiltern

Datenfilter können sowohl auf den Textkörper als auch auf den Header der Antwort des Anbieters angewendet werden.

Angenommen, der Anbieter gibt eine Textantwort wie folgt zurück:

{
  "id": "exampleCartId",
  "token": "exampleCartId",
  "email":"[e-mail]"
  }

Orchestrator-Ereignistrigger

Wenn Ihr Prozess ausgelöst werden soll, wenn das Token exampleCartId enthält, können Sie ihn so einrichten:

Hinweis:

Wenn eine JSON-Eigenschaft einen Bindestrich (-) enthält, muss er in doppelte Anführungszeichen eingefügt werden.
Beispiel: header."x-shopify-shop-domain" enthält ecommerce.

Ereignistrigger in Studio

Um das gleiche Verhalten mit der Triggeraktivität HTTP Webhook in Studio zu erzielen, konfigurieren Sie den Filter wie folgt:

Veröffentlichen

Veröffentlichen Sie Ihren Workflow ausgehend von einem HTTP Webhook-Ereignis, um die öffentlich zugängliche URL zu aktivieren. Sie können dies dann testen, indem Sie Ereignisse in der Anbieteranwendung auslösen oder einen direkten curl -Befehl an die URL senden:

Automation Cloud:

curl -X POST https://cloud.uipath.com/{webhook_url} -d "example 
            curl call"

Automation Cloud – öffentlicher Sektor:

curl -X POST https://govcloud.uipath.us/{webhook_url} -d "example
            curl call"

Wenn der Integration Service das Ereignis akzeptiert, antwortet er mit den folgenden JSON-Nutzdaten zurück:

{ "webhookEventId": "wr-4ad55717e1.a7bbf1e8-72a1-4371-82d2-d{example}", "correlationId": "384d496c-2f6d-{example}" }

Hinweis:

Diese Nutzlast ist nützlich zum Testen, aber nirgendwo in Ihrem Workflow erforderlich.