CLIReference

Manage Signals webhooks

Manages Signals webhooks (subscribers) through Ovok.

ovok webhooks <action> [id] [options]

Signals routes need a manager app.

Options

OptionTypeDefaultDescription
--url <url>stringThe URL Signals posts to; create needs it
--event <type>string, repeatablealert.*An event type to send; repeat it for more
--name <name>stringovok webhooks createThe webhook's name
--reach all|attachedstringallAll residents, or only those attached to the webhook
--profile <name>stringdefaultThe saved profile to use

Actions

  • list: Lists the Signals webhooks
  • create: Creates one and prints its signing secret once
  • delete <id>: Deletes one
  • test <id>: Sends a test event and prints the answer
  • rotate-secret <id>: Prints a new signing secret once
  • enable <id>: Resumes deliveries
  • disable <id>: Pauses deliveries

Examples

ovok webhooks list
ovok webhooks create --url https://example.com/signals --event alert.triggered
ovok webhooks test <id>

Last updated on

On this page