Verwenden des Webhook-Connectors

Using the HTTP Webhook connector from Studio

1. Select the HTTP Webhook trigger

   In Studio, select the HTTP Webhook trigger.

2. Create or select a connection

   Use an existing connection or create a new one.

3. Copy the webhook URL

   Retrieve the generated webhook URL from the trigger activity.

4. Configure your data filter

   Define the conditions under which the webhook event should trigger.

5. Publish your process

   Publish the workflow so it is available to be triggered.

6. Register the webhook URL in your application

   Paste the copied webhook URL from step 3 into your vendor application's webhook configuration.

Using the HTTP Webhook connector from Orchestrator

1. In Orchestrator, select Open Event Triggers > Add a new trigger.

2. Select your process, provide a name, and click Next.

3. Select Connector: HTTP Webhook.

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

   Use an existing connection or create a new one. Learn how to create connections.

5. Configure your data filter.

   Define the conditions under which the webhook event should trigger. Learn how to configure data filters.

6. Copy the webhook URL for later use.

7. Add the trigger to complete setup.

8. In your workflow, use the Get Trigger Event Output activity to utilize the webhook’s header or body.

   Pass UiPathEventObjectId (data type=Text) as the input argument for the required property UiPath event object ID.

Creating an HTTP Webhook connection

1. Name the connection
   In the What application is this webhook for field, enter a descriptive name for the webhook application, something that makes it easy to identify which vendor or integration this connection represents. This value becomes the Connection Identifier.
2. Configure the Challenge location
   Choose how the vendor will send the challenge token so UiPath can respond correctly or select No challenge. Common options:
   • Query parameter (e.g., ?challenge=...)
   • JSON body (POST with { "challenge": "..." })
   • Header (e.g., X-Hub-Challenge)
3. Configure the challenge verification and connect
   If the vendor requires a handshake, enter the challenge configuration that matches the vendor's pattern (which field/header/query to read and how to echo/validate it). When configuration is complete, click Connect. Learn more about Challenge verification.

Tipp:

• Use a name that includes the vendor and environment (for example, Stripe-prod or Slack-staging) to avoid confusion.
• If you're unsure which challenge pattern the vendor uses, check their webhook docs or run a test registration to inspect the handshake request.

Webhook challenge verification

Some vendors require webhook URLs to be validated before they start sending real events. This is done using a challenge–response mechanism. When you register a webhook, the vendor sends a special challenge request, and the endpoint must respond exactly as expected.

The HTTP Webhook connector supports these verification flows through the Webhook Challenges Framework, allowing you to configure how UiPath should read and respond to vendor challenges.

Challenge verification support

UiPath supports both types of vendor webhook behaviors:

• Vendors that do not use challenge verification
• Vendors that require a challenge handshake before activating the webhook

This ensures compatibility with simple webhook providers as well as those with more advanced security requirements.

When vendors do not use challenge verification

Many applications simply accept a webhook URL and start delivering events immediately.
For these vendors:

• Users only need to create or select a connection.
• Copy the webhook URL.
• Paste it into the vendor's webhook configuration.

No additional steps are required. The webhook becomes active as soon as the vendor starts sending events.

This is the most common and simplest scenario, and UiPath handles it seamlessly.

When vendors do require challenge verification

Some vendors send a challenge request to verify the webhook URL before enabling it.
In these cases:

• Users must configure the challenge response in the HTTP Webhook connection.
• UiPath listens for the vendor's challenge request.
• UiPath automatically returns the correct challenge value based on the configuration.
• Once the vendor validates the response, normal events begin to flow.

Because vendors differ in how they send the challenge (query param, JSON body, header, etc.), UiPath's configuration allows users to handle any of these patterns.

This ensures compatibility with webhook providers that enforce security handshakes such as Slack, Meta (Facebook/Instagram), Stripe, and others.

Configuring challenge verification

You configure challenge behavior using four parameters:

• Challenge Key
  Field/key containing the challenge value. Used to detect challenge requests (must not be null).

• Challenge Location
  Where the key appears:

  • Text
  • Abfrageparameter
  • Kopfzeile

• Challenge Response Content Type
  Format of the response returned back to the vendor:

  • text/plain
  • application/json

• Challenge Response Format
  Defines which value is returned (usually the challenge key itself).
  UiPath extracts the value from the incoming challenge and responds accordingly.

Generic example

Incoming request

 {
  "challenge": "ABC123"
 }

Konfiguration

• Challenge Key: challenge != null
• Challenge location: Body
• Response Type: text/plain
• Response Format: challenge

Antwort

ABC123

WhatsApp challenge verification example

WhatsApp uses the query parameter–based challenge method with hub.challenge.

Konfiguration

Parameter	Wert
Challenge Key	hub.challenge != null
Challenge Location	Abfrageparameter
Challenge Response Content Type	text/plain
Challenge Response Format	hub.challenge

Vendor request

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

Expected UiPath response

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

1234567890

This confirms ownership, and WhatsApp begins sending real webhook events afterward.

Summary—Generic vs WhatsApp

Schritt	Generic Example	WhatsApp Example
Challenge Location	Body / Query / Header	Abfrage
Key Fomat	Simple key (e.g., challenge)	Key with dot ("hub.challenge")
ResponseType	text/plain or application/json	text/plain
Response Value	Value of the key	Value of "hub.challenge"
Method	POST or GET	GET only

Configuring data filters

Data filters can be applied to both the body and the header of the provider’s response.

Let's assume the provider returns a body response as follows:

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

Orchestrator event triggers

If you want your process to trigger when the token contains exampleCartId, here’s how you can set it up:

Hinweis:

When a JSON property includes a hyphen (-), it must be enclosed in double quotes.
For example: header."x-shopify-shop-domain" contains ecommerce.

Studio event triggers

To accomplish the same behavior using the HTTP Webhook trigger activity in Studio, configure the filter as follows:

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.