uipath-cli
latest
false
UiPath CLI user guide
- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
Syntax and options for `uip is webhooks`, which retrieves the webhook URL for a connector trigger that uses webhook event mode.
uip is webhooks manages webhook configuration for connector triggers that fire via a registered webhook URL instead of polling. Not every trigger uses webhook event mode — check eventMode on uip is triggers describe first; this command is only useful when eventMode is webhooks.
Synopsis
uip is webhooks config <connector-key> --connection-id <id> --element-instance-id <id> [options]
uip is webhooks config <connector-key> --connection-id <id> --element-instance-id <id> [options]
Verbs
| Verb | Purpose |
|---|---|
config | Get the webhook URL for a connector trigger, for one connection and element instance. |
uip is webhooks config
Get the webhook URL to register with the external service so a webhook-mode trigger can fire.
Arguments
| Name | Required | Purpose |
|---|---|---|
<connector-key> | yes | Connector key, for example uipath-salesforce-slack. |
Options
| Short | Long | Value | Default | Description |
|---|---|---|---|---|
| — | --connection-id | id | — | Required. Connection UUID. Find it with uip is connections list. |
| — | --element-instance-id | id | — | Required. Numeric element instance ID. Find it in the ElementInstanceId field from uip is connections list --output json. |
Example
uip is webhooks config uipath-salesforce-slack \
--connection-id "28e2de45-24d9-4365-9a66-ae122055b634" \
--element-instance-id 333846
uip is webhooks config uipath-salesforce-slack \
--connection-id "28e2de45-24d9-4365-9a66-ae122055b634" \
--element-instance-id 333846
Data shape (--output json)
{
"Code": "WebhookConfig",
"Data": {
"WebhookUrl": "https://cloud.uipath.com/elements_/scaleunit_/.../v1/webhooks/connectors/uipath-salesforce-slack/events/TM3APD0SH",
"ConnectorKey": "uipath-salesforce-slack",
"ConnectionId": "28e2de45-24d9-4365-9a66-ae122055b634",
"ElementInstanceId": 333846
}
}
{
"Code": "WebhookConfig",
"Data": {
"WebhookUrl": "https://cloud.uipath.com/elements_/scaleunit_/.../v1/webhooks/connectors/uipath-salesforce-slack/events/TM3APD0SH",
"ConnectorKey": "uipath-salesforce-slack",
"ConnectionId": "28e2de45-24d9-4365-9a66-ae122055b634",
"ElementInstanceId": 333846
}
}
The response also carries a Hint reminding you that the trigger will not fire until WebhookUrl is registered in the external service's own app settings — this command only reads the URL, it does not register it anywhere.
Failure behavior
--element-instance-idthat doesn't parse as a number:Failure, checked client-side before any network call, withInstructionspointing at theElementInstanceIdfield onconnections list.
Related
uip is triggers—describe'seventModetells you whether a trigger needs a webhook at all.uip is connections— source of--connection-idand--element-instance-id.