UiPath Documentation
integration-service
latest
false
Integration Service user guide

About the HTTP Webhook connector

Configure the HTTP Webhook connector in Integration Service to receive real-time, event-driven callbacks from external applications without polling.

Webhooks enable applications to notify external systems in real time, reducing the need for frequent polling and minimizing API calls. Instead of periodically checking for updates, the system receives event-based callbacks only when relevant changes occur.

The UiPath HTTP Webhook connector allows you to trigger workflows directly from vendor applications. You can create instant triggers for events for any third-party application that supports outbound webhook notifications, even if it is not part of the connector catalog.

You can also apply event data filters to specify the exact conditions under which a webhook event should trigger a workflow.

How it works​

The HTTP Webhook trigger generates a dynamic public callback URL. Copy and configure this URL in the vendor application's webhook settings only after your trigger has been created in Orchestrator.

When an event occurs in the vendor system:

  1. The vendor sends the event payload to the configured URL.
  2. Integration Service receives the payload and evaluates it against your configured event data filters.
  3. If a match is found, Integration Service triggers the workflow execution through Orchestrator.

Webhook payloads are processed the same way as any other trigger events. The connector also supports optional header-based authentication and JWT authentication, which let the vendor authenticate itself to UiPath on every webhook delivery, with a configured header value or with a signed token.

For more information, refer to Using the Webhook connector.

For information on how to create a connection and configure challenge verification, if required by the vendor, refer to HTTP Webhook authentication.

Security​

The HTTP Webhook connector offers the following security mechanisms, all configured at connection-creation time. Header-based authentication and JWT authentication are alternatives: a connection uses one of them, or neither.

MechanismWhat it doesWhen to use
Challenge verificationLets the vendor confirm that your UiPath webhook URL is valid before sending events.When the vendor requires a handshake (Slack, Meta, etc.).
Header-based authenticationValidates every incoming webhook request using a shared secret carried in an HTTP header (for example, X-API-Key). Requests that don't carry the configured header value are rejected with HTTP 401.When you want to prevent unauthorized callers from posting to your webhook URL, and your vendor lets you configure a custom header on outbound webhook deliveries.
JWT authenticationValidates every incoming webhook request using a signed JWT in the Authorization: Bearer header with a shared secret or public key. Requests with a missing, invalid, or expired token are rejected with HTTP 401.When the sender can sign a JWT for each request, and you want credentials that expire instead of a static header value.

For setup details, see HTTP Webhook authentication.

Rate limits​

Webhook-triggered events are subject to the following limits:

  • 500 events per minute per tenant
  • 100 events per minute per connection

Limitations​

  • Design time trigger debugging is not currently available.
  • Only JSON format requests are supported.
  • The maximum supported webhook payload size is 14 MB. Requests exceeding this limit are rejected and no trigger event is dispatched.

Frequently asked questions​

I pasted the Webhook URL into the provider’s UI, why is verification still not passing?​

Verification will only succeed after the trigger is created in Orchestrator and provided you have configured the challenge correctly. Note that UiPath does not perform any challenge verification on our side—the validation happens entirely on the provider’s end in order to establish trust with the destination.

I configured the challenge incorrectly, why is my connection still being created successfully?​

UiPath does not currently validate the provider’s challenge/verification step. This validation is handled entirely by the vendor. As a result, the connection in UiPath may appear active even if the provider’s challenge verification has actually failed on their side.

How do I use the response coming from a webhook created in Orchestrator?​

Use the Get Trigger Event Output activity in your workflow and pass UiPathEventObjectId (data type=Text) as the input argument. The activity returns the body and the headers of the webhook request, except for headers that UiPath removes. For details, see Which headers does a webhook event include?.

Which headers does a webhook event include?​

A webhook event includes the headers that the sender added to the request. Headers that the UiPath network infrastructure uses are removed from the event, even when the sender adds them. The following headers are removed (matching isn't case-sensitive):

TypeRemoved headers
Exact nameshost, x-request-id, accountid, tenantid, ratelimit-limit, ratelimit-remaining, x-uipath-s2s-iprange, cf-ray, cf-visitor, cdn-loop, cf-connecting-ip, cf-ipcountry, true-client-ip
Prefixesx-forwarded- (including x-forwarded-for), x-envoy-, x-uipath-internal-

Other headers that start with cf-, such as cf-access-client-id, are kept, as are traceparent and tracestate.

Because of this, a webhook event doesn't include the caller's IP address or country. If your workflow needs them, ask the sender to include them in the request body or in a header with a different name.

The webhook response is a JSON string. How do I use parts of it in my workflow?​

Use the Deserialize JSON activity to convert the string into a JObject, after which you can easily access individual fields.

How do I read the query parameters of a webhook request?​

The HTTP Webhook trigger returns the query parameters in the Query parameter output. The Get Trigger Event Output activity returns them in the Event query parameter output. Both outputs are JSON strings of name-value pairs, for example {"source":"crm","page":"1"}. If the request has no query parameters, the output is {}.

All values are URL-decoded strings. If a parameter name appears more than once in the request, only the first value is kept. Use the Deserialize JSON activity to read individual values.

Triggers created before the Query parameter output was added return it after a trigger on the same connection is updated, for example when you edit the trigger or publish the project again.

Can I require the vendor to authenticate when sending webhook events to UiPath?​

Yes. Enable Header-based authentication or JWT authentication when creating or editing the connection, then configure the matching header or token in the vendor's webhook settings. For setup instructions, see HTTP Webhook authentication.

My vendor uses its own signature scheme (for example, X-Hub-Signature-256). Can I still use header-based authentication?​

No. Header-based authentication uses a static, pre-shared header value. Signature-based vendors compute a fresh HMAC on every request using the payload and a shared secret — UiPath does not currently validate vendor-specific signatures. For those vendors, the available security mechanisms are URL secrecy and the vendor's challenge verification handshake.

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated