prb webhook command reference
Reference for 8 commands under prb webhook, including usage, flag types and defaults, required flags, source examples, and implementation links
Manage webhook subscriptions. This page documents 8 commands under prb webhook.
Flags and examples below come from the command definitions. A Required flag is explicitly marked required by Cobra; an unmarked flag can still be needed by runtime validation or a non-interactive workflow. Empty strings and empty lists are registered defaults, not sample values.
Every command also inherits the global flags. Run prb <command> --help to check your installed version. Replace placeholder IDs and names in source examples before running them. Return to the complete CLI command reference to browse another command.
Commands
Section titled “Commands”| Command | Description | Usage | Source |
|---|---|---|---|
prb webhook | Manage webhook subscriptions. | prb webhook <command> | View implementation |
prb webhook create | Create a webhook subscription. | prb webhook create | View implementation |
prb webhook delete | Delete a webhook subscription. | prb webhook delete <id> | View implementation |
prb webhook event | Manage webhook events. | prb webhook event <command> | View implementation |
prb webhook event list | List events for a webhook subscription. | prb webhook event list <webhook-id> | View implementation |
prb webhook list | List webhook subscriptions. | prb webhook list | View implementation |
prb webhook update | Update a webhook subscription. | prb webhook update <id> | View implementation |
prb webhook view | View a webhook subscription. | prb webhook view <id> | View implementation |
prb webhook
Section titled “prb webhook”Manage webhook subscriptions.
prb webhook <command>prb webhook create
Section titled “prb webhook create”Create a webhook subscription.
prb webhook createAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--event | string list | [] | Required | Event types to subscribe to (required, can be repeated) |
--org | string | "" | — | Organization ID |
--url | string | "" | Required | Webhook endpoint URL (required) |
Examples
Section titled “Examples”# Create a webhook for third-party eventsprb webhook create --url https://example.com/webhook --event THIRD_PARTY_CREATED --event THIRD_PARTY_UPDATED
# Create a webhook for all supported eventsprb webhook create --url https://example.com/webhook --event THIRD_PARTY_CREATED --event THIRD_PARTY_UPDATED --event THIRD_PARTY_DELETED --event USER_CREATED --event USER_UPDATED --event USER_DELETED --event OBLIGATION_CREATED --event OBLIGATION_UPDATED --event OBLIGATION_DELETEDprb webhook delete
Section titled “prb webhook delete”Delete a webhook subscription.
prb webhook delete <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
prb webhook event
Section titled “prb webhook event”Manage webhook events.
prb webhook event <command>prb webhook event list
Section titled “prb webhook event list”List events for a webhook subscription.
prb webhook event list <webhook-id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit, -L | integer | 30 | — | Maximum number of events to list |
--order-by | string | "" | — | Order by field (CREATED_AT) |
--order-direction | string | "DESC" | — | Sort direction (ASC, DESC) |
--output, -o | string | "" | — | Output format: json, table (default) |
--status | string | "" | — | Filter by status (PENDING, SUCCEEDED, FAILED) |
prb webhook list
Section titled “prb webhook list”List webhook subscriptions.
prb webhook listAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit, -L | integer | 30 | — | Maximum number of webhook subscriptions to list |
--order-by | string | "" | — | Order by field (CREATED_AT) |
--order-direction | string | "DESC" | — | Sort direction (ASC, DESC) |
--org | string | "" | — | Organization ID |
--output, -o | string | "" | — | Output format: json, table (default) |
prb webhook update
Section titled “prb webhook update”Update a webhook subscription.
prb webhook update <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--event | string list | [] | — | Event types to subscribe to (replaces existing) |
--url | string | "" | — | Webhook endpoint URL |
prb webhook view
Section titled “prb webhook view”View a webhook subscription.
prb webhook view <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |