integration-service
2024.10
true
UiPath logo, featuring letters U and I in white
Integration Service for Automation Suite User Guide
Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Nov 11, 2024

Using the Webhook connector

Create a connection

  1. Find the HTTP Webhook connector in the Integration Service catalog.
  2. Select Connect to HTTP Webhook.
  3. In the connection screen, you must provide the application, for example, UiPath Forum.


  4. In Studio, start your workflow from a Webhook event. Select Webhook Event Happened as the trigger for your automation.

Note:

A connection is merely a reference that can be reused across workflows. It is tied to the same public-facing URL.

You can create this connection in a folder, so that others can also build workflows based on the same incoming Webhook events.

Copy the exposed URL into your vendor application

Once a connection is created, the event activity displays the webhook URL. You must copy this URL into the vendor application.


Define filters

Vendor applications send different payload structures or payload types, depending on the event being addressed. All of these can be sent through that same URL the trigger activity exposes. You differentiate between payloads by defining filters at the start of your process.

For example, for a payload including an event_type for new_post, updated_post, admin_removal on the forum, you can drive specific published workflows to be triggered or others ignored. Filtering provides full access to both the body and the headers sent by the vendor on the webhook.
Note: Define the body and header filters using lower case and quotes.


Define debugging payloads

This step is optional. You can simulate a perfect run during design time by adding a sample JSON payload for body and/or headers. This payload is saved as the output of the activity and can be used later on as variables.

Publish

Publish your workflow starting from an HTTP Webhook event to activate the public facing URL. You can then test this by triggering events in the vendor application or send a direct curl command to the URL: 
curl -X POST https://cloud.uipath.com/{entity_url} -d "example
            curl call"curl -X POST https://cloud.uipath.com/{entity_url} -d "example
            curl call"
When Integration Service accepts the event, it responds back with the following JSON payload: 
{ "webhookEventId": "wr-4ad55717e1.a7bbf1e8-72a1-4371-82d2-d{example}", "correlationId": "384d496c-2f6d-{example}" }{ "webhookEventId": "wr-4ad55717e1.a7bbf1e8-72a1-4371-82d2-d{example}", "correlationId": "384d496c-2f6d-{example}" }
Note:

This payload is useful for testing, but not necessary anywhere within your workflow.

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2024 UiPath. All rights reserved.