CLICommand referencewebhook webhook
Commands, arguments, and options for openship webhook.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
Manage incoming deploy and job webhooks
openship webhook [options] [command]
Create a webhook; credentials in the result must be kept private
openship webhook create [options] <file>
| Argument | Meaning |
|---|
file | JSON webhook definition |
| Option | Meaning |
|---|
-p, --project <id> | Project ID |
Inspect webhook deliveries with cursor pagination
openship webhook deliveries [options]
| Option | Meaning |
|---|
-p, --project <id> | Project ID |
--hook <id> | Only one webhook's deliveries |
--cursor <cursor> | Continue from the returned nextCursor |
--limit <n> | Page size (default: "50") |
Run this webhook's configured action as the current caller
openship webhook invoke [options] <id>
| Argument | Meaning |
|---|
id | Webhook ID |
| Option | Meaning |
|---|
-p, --project <id> | Project ID |
List a project's incoming webhooks
openship webhook list [options]
| Option | Meaning |
|---|
-p, --project <id> | Project ID |
Remove a webhook
openship webhook remove [options] <id>
| Argument | Meaning |
|---|
id | Webhook ID |
| Option | Meaning |
|---|
-p, --project <id> | Project ID |
-y, --yes | Skip confirmation |
Rotate a webhook's credential
openship webhook rotate [options] <id>
| Argument | Meaning |
|---|
id | Webhook ID |
| Option | Meaning |
|---|
-p, --project <id> | Project ID |
-y, --yes | Skip confirmation |
Update a webhook using the shared authorization rules
openship webhook update [options] <id> <file>
| Argument | Meaning |
|---|
id | Webhook ID |
file | JSON webhook patch |
| Option | Meaning |
|---|
-p, --project <id> | Project ID |