Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
CLICommands

orl webhooks update

Update a webhook (name/url/events), part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing. Usage, every flag and an example.

orl webhooks update <id>

Changes a webhook's name, URL or subscribed events and returns it. A field left out keeps its value; the signing secret and enabled state are not changed. Whatever it changes, an update needs the access the webhook's events need on create, since a new URL would redirect them.

Flags

FlagTypeRequired
--eventsvm.running, vm.stopped, vm.terminated, vm.interrupted, batch.completed, batch.failed, batch.expired, batch.cancelled, balance.low, balance.depletednoReplaces the event list, with the names and rules of create. Absent keeps the list as it is. A name outside this list is stored but never delivered (see create); * is not a wildcard.
--namestringno
--urlstringno
--bodystringnoa JSON object of request body fields, merged under any of this command's own flags that are also set, e.g. {"key":"value"}
--body-filestringnoread the --body JSON object from a file (- for stdin)

This wraps the updateOrgWebhook API operation.

On this page