signaloid-cli webhooks
Manage webhooks for event notifications.
Synopsis
signaloid-cli webhooks <command> [options]
Description
The webhooks command group allows you to configure webhooks to receive real-time notifications about builds, tasks, and other events in your Signaloid account.
Subcommands
- list - List all webhooks
- get - Get details about a specific webhook
- create - Create a new webhook
- update - Update webhook configuration
- delete - Delete a webhook
- stats - Get webhook statistics
- enable - Enable a webhook
- disable - Disable a webhook
Webhook Events
The API accepts the following event names. The API rejects any other event name with HTTP status 400.
| Event | Description |
|---|---|
task-status | A task changed status (Initialising, In Progress, Rescheduled, Completed, Cancelled, or Stopped). A failed task is reported as Stopped, with the reason in message. |
build-status | A build changed status, with the same statuses as task-status. A failed build is reported as Stopped, with the reason in message. |
task-count | The number of tasks in your account changed, because a task was created or finished. |
build-count | The number of builds in your account changed, because a build was created or finished. |
task-stats | The task execution statistics of your account changed (dynamic instructions and execution time). |
build-stats | The build statistics of your account changed (build size and build time). |
The platform disables a webhook automatically after a number of failed deliveries. For more details, see webhooks disable.
See Also
- signaloid-cli builds - Build events
- signaloid-cli tasks - Task events
Learn More
- Webhooks API reference - Webhook endpoints, payloads, and responses