# prb webhook command reference

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](/docs/developers/cli/commands#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](/docs/developers/cli/commands) to browse another command.

## Commands

| Command                                             | Description                             | Usage                                 | Source                                                                                                    |
| --------------------------------------------------- | --------------------------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| [`prb webhook`](#prb-webhook)                       | Manage webhook subscriptions.           | `prb webhook <command>`               | [View implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/webhook.go#L35)         |
| [`prb webhook create`](#prb-webhook-create)         | Create a webhook subscription.          | `prb webhook create`                  | [View implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/create/create.go#L68)   |
| [`prb webhook delete`](#prb-webhook-delete)         | Delete a webhook subscription.          | `prb webhook delete <id>`             | [View implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/delete/delete.go#L43)   |
| [`prb webhook event`](#prb-webhook-event)           | Manage webhook events.                  | `prb webhook event <command>`         | [View implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/event/event.go#L30)     |
| [`prb webhook event list`](#prb-webhook-event-list) | List events for a webhook subscription. | `prb webhook event list <webhook-id>` | [View implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/event/list/list.go#L79) |
| [`prb webhook list`](#prb-webhook-list)             | List webhook subscriptions.             | `prb webhook list`                    | [View implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/list/list.go#L73)       |
| [`prb webhook update`](#prb-webhook-update)         | Update a webhook subscription.          | `prb webhook update <id>`             | [View implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/update/update.go#L63)   |
| [`prb webhook view`](#prb-webhook-view)             | View a webhook subscription.            | `prb webhook view <id>`               | [View implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/view/view.go#L63)       |

## prb webhook

Manage webhook subscriptions.

### Usage

```text
prb webhook <command>
```

[View command implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/webhook.go#L35).

## prb webhook create

Create a webhook subscription.

### Usage

```text
prb webhook create
```

Accepts no positional arguments.

### Flags

| 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

```bash
# Create a webhook for third-party events
prb webhook create --url https://example.com/webhook --event THIRD_PARTY_CREATED --event THIRD_PARTY_UPDATED

# Create a webhook for all supported events
prb 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_DELETED
```

[View command implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/create/create.go#L68).

## prb webhook delete

Delete a webhook subscription.

### Usage

```text
prb webhook delete <id>
```

Requires 1 positional argument.

### Flags

| Flag          | Type    | Default | Required | Description              |
| ------------- | ------- | ------- | -------- | ------------------------ |
| `--yes`, `-y` | boolean | `false` | —        | Skip confirmation prompt |

[View command implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/delete/delete.go#L43).

## prb webhook event

Manage webhook events.

### Usage

```text
prb webhook event <command>
```

[View command implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/event/event.go#L30).

## prb webhook event list

List events for a webhook subscription.

### Usage

```text
prb webhook event list <webhook-id>
```

Requires 1 positional argument.

### Flags

| 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)        |

[View command implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/event/list/list.go#L79).

## prb webhook list

List webhook subscriptions.

### Usage

```text
prb webhook list
```

Accepts no positional arguments.

### Flags

| 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)                 |

[View command implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/list/list.go#L73).

## prb webhook update

Update a webhook subscription.

### Usage

```text
prb webhook update <id>
```

Requires 1 positional argument.

### Flags

| Flag      | Type        | Default | Required | Description                                     |
| --------- | ----------- | ------- | -------- | ----------------------------------------------- |
| `--event` | string list | `[]`    | —        | Event types to subscribe to (replaces existing) |
| `--url`   | string      | `""`    | —        | Webhook endpoint URL                            |

[View command implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/update/update.go#L63).

## prb webhook view

View a webhook subscription.

### Usage

```text
prb webhook view <id>
```

Requires 1 positional argument.

### Flags

| Flag             | Type    | Default | Required | Description                          |
| ---------------- | ------- | ------- | -------- | ------------------------------------ |
| `--json`         | boolean | `false` | —        | Output JSON (same as --output json)  |
| `--output`, `-o` | string  | `""`    | —        | Output format: json, table (default) |

[View command implementation](https://github.com/getprobo/probo/blob/main/pkg/cmd/webhook/view/view.go#L63).