veirox webhook
Manage webhook configs, events, and routing rules
Synopsis
veirox webhook <subcommand> [args] [flags]
Description
Manage webhook configs, events, and routing rules
Subcommands
| Command | Description |
|---|---|
veirox webhook create <task-id> | Attach a webhook config to a task |
veirox webhook delete <task-id> | Detach the webhook from a task |
veirox webhook events | List webhook events |
veirox webhook for-task <task-id> | Show the webhook config attached to a task |
veirox webhook info <webhook-id> | Show one webhook config |
veirox webhook list | List webhook configurations |
veirox webhook metrics | Show webhook metrics |
veirox webhook providers | List supported webhook providers |
veirox webhook recipes | List webhook recipes |
veirox webhook replay <event-id> | Replay a webhook event |
veirox webhook rotate <webhook-id> | Rotate the webhook signing secret |
veirox webhook routing-rules | Manage webhook routing rules |
veirox webhook stats | Show webhook config stats |
veirox webhook test <webhook-id> | Send a test event to a webhook config |
veirox webhook update <task-id> | Update the webhook config attached to a task |
veirox webhook create <task-id>
Attach a webhook config to a task
| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | — | config display name |
veirox webhook create <task-uuid> --name 'AlertManager'
veirox webhook delete <task-id>
Detach the webhook from a task
| Flag | Type | Default | Description |
|---|---|---|---|
--yes | bool | false | confirm deletion |
veirox webhook delete <task-uuid> --yes
veirox webhook events
List webhook events
| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 0 | page size |
--offset | int | 0 | pagination offset |
veirox webhook events --limit 50
veirox webhook for-task <task-id>
Show the webhook config attached to a task
veirox webhook for-task <task-uuid>
veirox webhook info <webhook-id>
Show one webhook config
veirox webhook info 00000000-0000-4000-8000-000000000001
veirox webhook list
List webhook configurations
| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 0 | page size |
--offset | int | 0 | pagination offset |
veirox webhook list --limit 25
veirox webhook metrics
Show webhook metrics
veirox webhook metrics
veirox webhook providers
List supported webhook providers
veirox webhook providers
veirox webhook recipes
List webhook recipes
veirox webhook recipes
veirox webhook replay <event-id>
Replay a webhook event
veirox webhook replay 00000000-0000-4000-8000-000000000001
veirox webhook rotate <webhook-id>
Rotate the webhook signing secret
veirox webhook rotate 00000000-0000-4000-8000-000000000001
veirox webhook routing-rules
Manage webhook routing rules
veirox webhook stats
Show webhook config stats
veirox webhook stats
veirox webhook test <webhook-id>
Send a test event to a webhook config
| Flag | Type | Default | Description |
|---|---|---|---|
--body-json | string | — | JSON object to send as the test payload |
veirox webhook test <uuid> --body-json '{"hello":"world"}'
veirox webhook update <task-id>
Update the webhook config attached to a task
| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | — | new config name |
veirox webhook update <task-uuid> --name 'PagerDuty Inbound'
Exit codes
| Code | Meaning |
|---|---|
0 | Success. |
1 | Generic error (network, API 5xx). |
2 | Validation error (bad flag, missing required arg). |
3 | Unauthenticated — run veirox login or set VEIROX_API_KEY. |
4 | Not found (resource does not exist in this project). |
5 | Permission denied (your role / API key lacks the scope). |