UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip insights alert-deliveries

Syntax and options for `uip insights alert-deliveries`, which reads UiPath Insights alert delivery metadata.

uip insights alert-deliveries reads metadata about where an alert's notifications are sent. This is a read-only, by-ID-only surface — there is no list verb; look up a deliveryId from an alerts or alert-history row first.

Note:

Recipient identities are never returned, by design — not even in a redacted form. Use recipientCount to confirm a delivery has recipients configured.

Synopsis

uip insights alert-deliveries get <delivery-id>
uip insights alert-deliveries get <delivery-id>

This verb honors the global options and the standard exit codes. It does not accept -t, --tenant — it uses the tenant selected during uip login.

uip insights alert-deliveries get

Get metadata for one alert delivery by its integer ID.

Arguments

  • <delivery-id> (required) — the alert delivery's integer ID (the deliveryId field from an alerts or alert-history row).

Example

uip insights alert-deliveries get 7
uip insights alert-deliveries get 7

Data shape

{
  "Code": "InsightsAlertDeliveryGet",
  "Data": {
    "id": 7,
    "type": "email",
    "recipientCount": 3,
    "tenantMatches": true
  }
}
{
  "Code": "InsightsAlertDeliveryGet",
  "Data": {
    "id": 7,
    "type": "email",
    "recipientCount": 3,
    "tenantMatches": true
  }
}
  • recipientCount — the number of configured recipients. 0 means a broken delivery (the backend rejects saving a delivery with an empty recipient list, so a live delivery showing 0 indicates a defect, not an intentionally silent one).
  • tenantMatches — whether the delivery's tenant matches your active session's tenant. This is a sanity boolean, not the tenant ID itself; a false value indicates a backend defect, since the route is already scoped to your tenant.

A 404 means the delivery ID doesn't exist, or belongs to another tenant — these two causes can't be distinguished from the response.

  • alerts — source of the deliveryId on an alert definition row.
  • alert-history — source of the deliveryId on a trigger history row.

See also

  • Synopsis
  • uip insights alert-deliveries get
  • Arguments
  • Example
  • Data shape
  • Related
  • See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated