# uip or webhooks

> Syntax and options for `uip or webhooks`, which manages Orchestrator HTTP callbacks fired on platform events.

Manage Orchestrator **webhooks** — HTTP callbacks fired on platform events (job completion, queue-item failure, and so on). Webhooks are tenant-scoped.

For the cross-resource conventions (auth, key types, output envelope), see the [`uip or` overview](./uip-or.md).

## Synopsis

```
uip or webhooks list         [-n <name>] [--enabled | --disabled] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or webhooks get          <webhook-key> [--all-fields]
uip or webhooks create       <name> --url <url> [-d <desc>] [--events <list>] [--secret <s>] [--allow-insecure-ssl]
uip or webhooks update       <webhook-key> [flags as for create] [--enabled | --disabled]
uip or webhooks delete       <webhook-key> --yes
uip or webhooks ping         <webhook-key>
uip or webhooks event-types
```

## list

List webhooks. Filters: `-n, --name`, `--enabled`, `--disabled` (mutually exclusive). `--sort-by <field>` sorts results (default `Id desc`); `--all-fields` returns the full API response.

## get

Get webhook details by key, including subscribed events and SSL settings. `--all-fields` returns the full API response.

## create

Create a webhook. Requires `<name>` and `--url`. Optional `-d, --description`, `--events <comma-list>` (omit to subscribe to all event types), `--secret`, `--allow-insecure-ssl`.

```bash
uip or webhooks create JobAlerts \
  --url https://hooks.example.com/uipath \
  --events "job.completed,job.faulted"
```

## update

Update by key. Providing `--events` switches the webhook from subscribe-to-all to the given list. Pass `--enabled` or `--disabled` to toggle the webhook's state (mutually exclusive).

```bash
uip or webhooks update <webhook-key> --disabled
```

## delete

Delete a webhook by key. Requires `-y, --yes` — the CLI never prompts for destructive operations.

```bash
uip or webhooks delete <webhook-key> --yes
```

## ping

Send a test ping to the webhook URL to verify connectivity. Delivery is asynchronous — a successful response means the ping was queued, not that the endpoint received it; confirm receipt on the endpoint itself.

## event-types

List every event type a webhook can subscribe to. Use the returned names with `create --events` or `update --events`.

```bash
uip or webhooks event-types
```

## Exit codes

See [Exit codes](./exit-codes.md) for the shared contract. `delete` exits `1` if `-y, --yes` is omitted.

## See also

- [`uip or` overview](./uip-or.md) — shared conventions for every `uip or` verb.
- [How-to: manage Orchestrator assets and queues](./howto-manage-resources.md) — webhook creation patterns.