# Webhook

> Shoplazza CLI 的 webhook 命令：创建、查询、更新、删除和统计事件订阅，把店铺事件推送到你的应用。

注册和管理 Webhook 事件订阅。6 个 API 命令。

所有 webhook 命令共享以下参数：

| 参数 | 短参 | 说明 |
|------|------|------|
| `--params` | | 路径/查询参数（JSON 格式） |
| `--data` | | 请求体（JSON 格式） |
| `--jq` | `-q` | jq 表达式过滤输出 |
| `--dry-run` | | 预览请求，不实际执行 |

## create

注册一个新的 Webhook。

```shell
shoplazza webhook create --data '<json_body>'
```

请求体须包含 `address`（通知 URL）和 `topic`（事件名称）。

### 示例

```shell
shoplazza webhook create --data '{
  "webhook": {
    "topic": "orders/create",
    "address": "https://example.com/hook"
  }
}'
```

## list

列出所有已注册的 Webhook。

```shell
shoplazza webhook list
```

### 示例

```shell
shoplazza webhook list --format table
```

## get

查看指定 Webhook 的详情。

```shell
shoplazza webhook get --params '{"webhook_id":"123"}'
```

## update

更新 Webhook 订阅。

```shell
shoplazza webhook update --params '{"webhook_id":"123"}' --data @webhook.json
```

### 示例

```shell
shoplazza webhook update --params '{"webhook_id":"123"}' --data '{
  "webhook": {
    "address": "https://example.com/webhooks/orders-v2"
  }
}'
```

## delete

删除 Webhook 订阅。

```shell
shoplazza webhook delete --params '{"webhook_id":"123"}'
```

## count

统计已注册的 Webhook 数量。

```shell
shoplazza webhook count
```

## 相关

* [Webhook 概述](/docs/app/building-blocks/webhooks/overview) — 事件类型与负载格式
* [支持的 Webhook 事件](/docs/app/building-blocks/webhooks/supported-webhook-events/) — 完整事件参考