> ## Documentation Index
> Fetch the complete documentation index at: https://docs.velafi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 更新 Webhook

> 在请求中将 webhookId 作为路径参数传入，以更新现有 Webhook 端点的回调 URL 或启用/停用该端点。

使用此端点修改现有的 Webhook。您可以更新回调 URL、更改状态以停用或重新启用推送，也可以同时进行这两项操作。`webhookId` 作为 URL 路径参数传入。更改会立即生效——停用 Webhook 后将停止事件推送，直到您重新启用它。Webhook 停用期间发生的事件不会进入队列，重新启用后也不会补发。已删除的 Webhook 无法更新。

> [!NOTE]
>
> 所有请求都必须包含 `X-BH-TOKEN` 请求头和 `Content-Type: application/json`。

## 端点

`PUT https://api.velafi.com/v2/webhook/{webhookId}`

## 路径参数

**webhookId** `string` *required*

要更新的 Webhook 的唯一 ID。可从[创建 Webhook](https://docs.velafi.com/cn/api-reference/webhooks/create-webhook-endpoints.md)或[列出 Webhook](https://docs.velafi.com/cn/api-reference/webhooks/get-webhook-endpoints.md)的响应中获取。

## 请求参数

**url** `string`

可选。此 Webhook 的新回调 URL，必须以 `http` 开头。如果省略，URL 保持不变。

**status** `number`

可选。Webhook 的更新状态：`10` = 启用，`20` = 停用。`30` 会被拒绝——请改用[删除 Webhook](https://docs.velafi.com/cn/api-reference/webhooks/delete-a-webhook.md)。如果省略，状态保持不变。

## 响应字段

**code** `number`

HTTP 风格的响应码。`200` 表示成功。

**msg** `string`

人类可读的状态消息，例如 `SUCCESS`。

**data** `object`

**data 字段**

**webhookId** `string`

已更新的 Webhook 的 ID。

**eventType** `string`

此 Webhook 注册的事件类型（保持不变）。

**url** `string`

更新后的回调 URL。

**status** `number`

更新后的状态：`10` = 启用，`20` = 停用，`30` = 已删除。

**publicKey** `string`

用于验证 Webhook 签名的 Base64 编码 RSA 公钥（保持不变）。

## 示例

```bash cURL theme={null}
curl -X PUT https://api.velafi.com/v2/webhook/ebab8a9663704e7cbbebe672c7c67912 \
  -H "X-BH-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/velafi-v2",
    "status": 10
  }'
```

```json Response theme={null}
{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "webhookId": "ebab8a9663704e7cbbebe672c7c67912",
    "eventType": "ORDER_WEBHOOK",
    "url": "https://your-app.com/webhooks/velafi-v2",
    "status": 10,
    "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAp/6GRTIrl+kQb9u27cGz..."
  }
}
```

> [!NOTE]
>
> 您无法更改现有 Webhook 的 `eventType`。如需监听其他事件，请创建新的 Webhook 并删除旧的 Webhook。


## Related topics

- [获取 Webhook 列表](https://docs.velafi.com/cn/api-reference/webhooks/get-webhook-endpoints.md)
- [加密货币提现事件](https://docs.velafi.com/cn/api-reference/webhooks/crypto-withdraw-message-push.md)
- [更新日志](https://docs.velafi.com/cn/docs/changelog.md)
- [Webhook](https://docs.velafi.com/cn/docs/guides/webhooks.md)
- [全球支付（法币兑法币）](https://docs.velafi.com/cn/docs/guides/global-payments.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.