Skip to main content

signaloid-cli webhooks update

Update webhook configuration.

Synopsis​

signaloid-cli webhooks update --webhook-id <id> [options]

Options​

OptionRequiredDescription
--webhook-id <id>YesWebhook ID
--url <url>NoNew https URL. It must not point to a private or internal address.
--events <events>NoNew event list, from task-status, build-status, task-stats, build-stats, task-count, build-count. The CLI rejects other names. For details, see Webhook events.
--description <text>NoNew description
--status <status>NoUpdate status: active or disabled
--activeNoSet status to active
--disabledNoSet status to disabled
--payload-file <path>NoPath to a JSON file whose fields are merged into the update request (advanced). Field names are PascalCase, such as Description. The CLI rejects the old lowercase names.
--format <type>NoOutput 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 does not include the webhook's signing Secret. Only webhooks create shows it, once.

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 --active or --disabled flags 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​