- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Using UiPath CLI
- Guides pratiques
- CI/CD recipes
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Global options
- uip codedagent
- uip docsai
- .mvp
- Connexions
- Activités (Activities)
- Ressources
- Déclencheurs (Triggers)
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- créer-projet
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-workflow-examples
- pack
- restore
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- Migration
- Reference & support
UiPath CLI user guide
uip is triggers is the read-only view onto a connector's event hooks — the metadata that backs trigger activities. A trigger fires when a connector object is CREATED, UPDATED, or DELETED. objects lists the objects that support a trigger operation; describe returns the full trigger metadata (event mode, parameters, filter fields, output fields) for one object. Both verbs cache results; --connection-id is optional but recommended — without it, custom objects/fields may be missing and the response carries a Warning.
Synopsis
uip is triggers <verb> [options]
uip is triggers <verb> [options]
Verbs
| Verb | Objectif |
|---|---|
objects | List objects that support a trigger operation on a connector. |
describe | Get full trigger metadata for one object under one operation. |
uip is triggers objects
List objects that support a given trigger operation on a connector. Cached results are only written when --connection-id is provided.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<connector-key> | oui | Connector key, for example uipath-zoho-desk. |
<operation> | oui | Trigger operation: CREATED, UPDATED, or DELETED (case-insensitive; normalized to uppercase). |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --connection-id | id | — | Scope to a connection (enables custom objects). |
-t | --tenant | name | session default | Override the tenant. |
| — | --refresh | flag | off | Force re-fetch from the API, ignoring cache. |
Exemples
uip is triggers objects uipath-zoho-desk CREATED
# Connection-scoped — includes custom objects
uip is triggers objects uipath-zoho-desk UPDATED \
--connection-id a1b2c3d4-0000-0000-0000-000000000001
uip is triggers objects uipath-zoho-desk DELETED \
--output-filter 'Data[].{name:name, display:displayName}'
uip is triggers objects uipath-zoho-desk CREATED
# Connection-scoped — includes custom objects
uip is triggers objects uipath-zoho-desk UPDATED \
--connection-id a1b2c3d4-0000-0000-0000-000000000001
uip is triggers objects uipath-zoho-desk DELETED \
--output-filter 'Data[].{name:name, display:displayName}'
Data shape (--output json)
{
"Code": "TriggerObjectList",
"Data": [
{
"displayName": "Tickets",
"name": "tickets",
"isHidden": false,
"supportedAuths": []
}
]
}
{
"Code": "TriggerObjectList",
"Data": [
{
"displayName": "Tickets",
"name": "tickets",
"isHidden": false,
"supportedAuths": []
}
]
}
Without --connection-id, the response carries a Warning noting that custom objects may be missing.
uip is triggers describe
Return full trigger metadata for one object under one trigger operation: event mode (polling vs webhook), event parameters, filter fields, and output fields.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<connector-key> | oui | Connector key. |
<operation> | oui | Trigger operation (CREATED, UPDATED, DELETED). |
<object-name> | oui | Object name (for example, tickets). Find it with triggers objects. |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --connection-id | id | — | Scope to a connection (enables custom fields). |
-t | --tenant | name | session default | Override the tenant. |
| — | --refresh | flag | off | Force re-fetch from the API, ignoring cache. |
Exemples
uip is triggers describe uipath-zoho-desk CREATED tickets
uip is triggers describe uipath-zoho-desk CREATED tickets \
--connection-id a1b2c3d4-0000-0000-0000-000000000001
uip is triggers describe uipath-zoho-desk UPDATED tickets \
--output-filter 'Data.outputFields[].name'
uip is triggers describe uipath-zoho-desk CREATED tickets
uip is triggers describe uipath-zoho-desk CREATED tickets \
--connection-id a1b2c3d4-0000-0000-0000-000000000001
uip is triggers describe uipath-zoho-desk UPDATED tickets \
--output-filter 'Data.outputFields[].name'
Data shape (--output json)
{
"Code": "TriggerMetadata",
"Data": {
"name": "tickets",
"displayName": "Tickets",
"elementKey": "uipath-zoho-desk",
"operation": "CREATED",
"eventMode": "polling",
"eventParameters": [],
"filterFields": [ { "name": "subject", "type": "string" } ],
"outputFields": [ { "name": "id", "type": "string" } ]
}
}
{
"Code": "TriggerMetadata",
"Data": {
"name": "tickets",
"displayName": "Tickets",
"elementKey": "uipath-zoho-desk",
"operation": "CREATED",
"eventMode": "polling",
"eventParameters": [],
"filterFields": [ { "name": "subject", "type": "string" } ],
"outputFields": [ { "name": "id", "type": "string" } ]
}
}
For CRUD-style operations, the response also surfaces a Hint suggesting the neighboring triggers objects command. Without --connection-id, the response carries a Warning about missing custom fields.
Related
uip is activities— pass--triggersto list trigger activities only.uip is connectors—connectors getreportsHasEvents: "Yes"for connectors that expose triggers.uip is connections— supply--connection-idfrom a connection here for custom-aware metadata.uip is resources— sibling resource for the data-plane (CRUD) side of the same connector.