signaloid-cli webhooks update
Update webhook configuration.
Synopsis
signaloid-cli webhooks update --webhook-id <id> [options]
Options
| Option | Required | Description |
|---|---|---|
--webhook-id <id> | Yes | Webhook ID |
--url <url> | No | New URL |
--events <events> | No | New event list. For the accepted event names, see Webhook events. |
--description <text> | No | New description |
--status <status> | No | Update status: active or disabled |
--active | No | Set status to active |
--disabled | No | Set status to disabled |
--payload-file <path> | No | Path to a JSON file whose fields are merged into the update request (advanced) |
--format <type> | No | Output format: table or json (default: json) |
Description
Updates the configuration of an existing webhook. You can modify the target URL, subscribed events, or status. Only the specified options will be updated. Other settings remain unchanged.
Examples
The output of this command includes the webhook secret in plain text. Treat the output as sensitive, and do not store it in logs or share it.
Update webhook status to active:
signaloid-cli webhooks update \
--webhook-id wh-0123456789abcdef0123456789abcdef \
--active
Change webhook URL and events:
signaloid-cli webhooks update \
--webhook-id wh-0123456789abcdef0123456789abcdef \
--url https://new.example.com/webhooks \
--events build-status,build-count
Notes
- Only specified options are updated. Other settings remain unchanged
- Use
--activeor--disabledflags as shortcuts for status changes - Updating events replaces the entire event list (not additive)
Troubleshooting
Update fails with "Webhook not found"
- Verify the webhook ID using
webhooks list - Ensure you have permission to modify the webhook
Events not being delivered after update
- Verify the webhook is active using
webhooks get - Check that the new URL is accessible
See Also
- signaloid-cli webhooks - Webhook command overview
- signaloid-cli webhooks get - Get webhook details
- signaloid-cli webhooks enable - Enable webhooks
- signaloid-cli webhooks disable - Disable webhooks