Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Managing Webhooks

Creating a Webhook


  1. In the Webhooks page, click Add. The Webhooks > Add page is displayed.
  2. In the mandatory Name field, enter a name for your webhook. A string of maximum 128 characters is allowed.
    Note: Make sure the Name is unique, as two live webhooks cannot share the same name at tenant level. A specific name is released when the corresponding webhook is deleted.
  3. In the Description field, enter a description for your webhook. A string of maximum 256 characters is allowed.
  4. In the URL field provide a custom URL to which you want to send information from Orchestrator.
  5. Select the Disable SSL Verification check box if you do not want the webhook communication to be secure. This option is not recommended!
  6. Clear the Enabled check box if you want to disable the webhook you are creating.
  7. (Optional) Add a custom secret, up to 100 characters long, if you want the webhook authentication to be more secure. For more information on authentication, please see this page.
  8. Select the Send All Events or Select Individual Events option. The first enables you to send all the available Orchestrator events to the specified URL, while the latter enables you to indicate individual events.
  9. Click Save. The webhook has been created. You start receiving the corresponding payloads as soon as they are triggered.

Editing a Webhook


  1. Click the corresponding Edit button. The Edit page is displayed.
  2. Make the necessary changes to your webhook (all fields are editable).
  3. Click Update. Your changes are saved successfully and the updated Webhooks page is displayed.

Enabling or Disabling a Webhook


To enable or disable a webhook, click the toggle in the Enabled column. When a webhook is enabled, the toggle is blue.

Removing a Webhook


  1. Click the corresponding Delete button. You are prompted to confirm.
  2. Click Yes. The webhook is removed and the updated Webhooks page is displayed.

Updated about a month ago


Managing Webhooks


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.