> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lazycloud.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# webhook

> Send task and deploy events from a workspace to your own HTTP endpoints.

A webhook posts the events it subscribes to to a URL. It receives every app's
events unless `--app` limits it to some; repeat `--app` for several. Webhooks are addressed by id; `list`
prints the ids.

## lazycloud webhook

```bash theme={null}
uv run lazycloud webhook list
uv run lazycloud webhook add URL --event EVENT [--event EVENT ...] [--app NAME ...] [--description TEXT] [--disabled]
uv run lazycloud webhook update WEBHOOK [--url URL] [--event EVENT ...] [--app NAME ... | --all-apps] [--description TEXT] [--enable | --disable]
uv run lazycloud webhook remove WEBHOOK
uv run lazycloud webhook test WEBHOOK                   # queues a webhook.test delivery
uv run lazycloud webhook deliveries WEBHOOK [--limit <n>]  # newest first, default 50
```

Events are `task.succeeded`, `task.failed`, `task.cancelled`,
`workload.deployed` and `workload.failed`. `update --event` replaces the whole
list.

```bash theme={null}
uv run lazycloud webhook add https://hooks.example.com/lazycloud --event task.failed --app tools
uv run lazycloud webhook test WEBHOOK
uv run lazycloud webhook deliveries WEBHOOK
```

[Webhooks](https://docs.lazycloud.dev/platform/webhooks.md) describes the requests a webhook receives.

> [!NOTE]
>
> To change your default workspace, run `uv run lazycloud workspace use <name>`.
> Commands with a `--workspace` option can override it for one call.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.