orl webhooks create
Create a webhook (secret returned once), part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing.
orl webhooks create --name <name> --url <url>Registers an HTTPS URL for the events you list and returns the webhook with its whsec_ signing secret, the only time that secret is returned. Each delivery is a signed POST of {id, type, created_at, data}. Listing a batch event needs batch read access and a balance event billing read access, beside webhook write access (403 otherwise). A name the platform sends no event for is stored and never delivered.
Flags
| Flag | Type | Required | |
|---|---|---|---|
--events | vm.running, vm.stopped, vm.terminated, vm.interrupted, batch.completed, batch.failed, batch.expired, batch.cancelled, balance.low, balance.depleted | no | The event types to deliver: vm.running, vm.stopped, vm.terminated, vm.interrupted, batch.completed, batch.failed, batch.expired, batch.cancelled, balance.low and balance.depleted. Empty or absent delivers the four vm events; a batch or balance event reaches only a webhook that lists it. Listing a batch event also needs batch read access, and a balance event billing read access. A name outside this list is stored but never delivered: the server does not reject it, so an existing webhook may carry one from before this list existed. * is not a wildcard; it matches nothing. |
--name | string | yes | |
--url | string | yes | |
--body | string | no | a JSON object of request body fields, merged under any of this command's own flags that are also set, e.g. {"key":"value"} |
--body-file | string | no | read the --body JSON object from a file (- for stdin) |
This wraps the createOrgWebhook API operation.
orl vms visibility set
Set a VM's endpoint visibility, part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing. Usage, every flag and an example.
orl webhooks delete
Delete a webhook (asks for confirmation; --yes to skip), part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing.