Webhooks Scripts

Publish to Webhooks

The following table describes all the parameters that you can use with the Publish-Webhooks.ps1 script.

Parameter	Description
`-action`	Indicate the scenario to be run, the available options are: `Deploy` - specifies it is a clean installation; `Update` - specifies you are updating your Webhooks Service instance.
`-azureAccountApplicationId`	The Azure service principal ID. Note: The indicated service principal must be assigned the Contributor role to the app service at the subscription scope.
`-azureAccountPassword`	The Azure token password for the service principal ID.
`-azureSubscriptionId`	The Azure subscription ID for the respective App Service.
`-azureAccountTenantId`	The Azure tenant ID.
`-appServiceName`	The Webhook Azure App Service name. Note: This should be different from your Orchestrator App Service name.
`-resourceGroupName`	The name of the Azure Resource Group that contains the Webhook App Service.
`-package`	Indicate the full path or relative path of the `UiPath.WebhookService.zip` archive.
`-stopApplicationBeforePublish`	When present, stops the application prior to beginning the deployment and then restarts it after the deployment is complete.
`-noAzureAuthentication`	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the `UseServicePrincipal` parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.
`-azureUSGovernmentLogin`	Optional. This parameter is only used for US Government deployments.

The Publish-Webhooks.ps1 script is used for the initial deployment or update of Webhooks. The script assumes that the web app already has the DefaultConnection database connection string configured.

.\Publish-Webhooks.ps1 `
-action deploy `
-package ".\UiPath.WebhookService.Web.zip" `
-azureAccountApplicationId "<AzureApplicationID>" `
-azureAccountPassword "<AzureAccountPassword>" `
-azureSubscriptionId "<SubscriptionID>" `
-azureAccountTenantId "<TenantID>" `
-resourceGroupName "<AzureResourceGroupYouPickedInStep1>" `
-appServiceName "<UiPathWebhookService>".\Publish-Webhooks.ps1 `
-action deploy `
-package ".\UiPath.WebhookService.Web.zip" `
-azureAccountApplicationId "<AzureApplicationID>" `
-azureAccountPassword "<AzureAccountPassword>" `
-azureSubscriptionId "<SubscriptionID>" `
-azureAccountTenantId "<TenantID>" `
-resourceGroupName "<AzureResourceGroupYouPickedInStep1>" `
-appServiceName "<UiPathWebhookService>"

Important: Following an initial deployment, you must also execute the MigrateTo-Webhooks.ps1 script.

Migrate to Webhooks

The following table describes all the parameters that you can use with the MigrateTo-Webhooks.ps1 script.

Parameters	Description
`-cliPackage`	Indicate the path to the `UiPath.WebhookService.Migrate.Cli.zip` archive.
`-azureDetails`	A hash table with the following values: `azureAccountApplicationId` - The Azure service principal ID.. `azureAccountPassword` - The Azure token password for the service principal ID. `azureSubscriptionId` - The Azure subscription ID for the respective App Service. `azureAccountTenantId`- The Azure tenant ID.
`-orchDetails`	A hash table with the following values: `resourceGroupName` - The name of the Azure Resource Group that contains the Orchestrator App Service. `appServiceName` - The Orchestrator App Service name. `targetSlot` - The Target App Service Slot set by Azure.
`-webhooksDetails`	A hash table with the following values: `resourceGroupName` - The name of the Azure Resource Group that contains the Webhook App Service. `appServiceName` - The Webhook App Service name. `targetSlot` - The Target App Service Slot set by Azure.
`-noAzureAuthentication`	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the `UseServicePrincipal` parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.

This MigrateTo-Webhooks.ps1 script is used to migrate data from an existing Orchestrator instance to a new Webhook App Service and set the configurations for both. The script assumes that Orchestrator and Webhooks are already published.

.\MigrateTo-Webhooks.ps1 `
    -cliPackage "UiPath.WebhookService.Migrator.Cli.zip"`
    -azureDetails @{azureSubscriptionId = "<subscription_id>"; azureAccountTenantId = "<azure_tenant_id>"; azureAccountApplicationId = "<azure_application_id>"; azureAccountPassword = "<azure_account_password>" } `
    -orchDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>";  targetSlot = "Production" } `
    -webhookDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production" }.\MigrateTo-Webhooks.ps1 `
    -cliPackage "UiPath.WebhookService.Migrator.Cli.zip"`
    -azureDetails @{azureSubscriptionId = "<subscription_id>"; azureAccountTenantId = "<azure_tenant_id>"; azureAccountApplicationId = "<azure_application_id>"; azureAccountPassword = "<azure_account_password>" } `
    -orchDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>";  targetSlot = "Production" } `
    -webhookDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production" }

On this page

Publish to Webhooks
Migrate to Webhooks

Was this page helpful?

PREVIOUSIdentity Server Scripts

NEXTResource Catalog Scripts

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy