创建 Webhook

Webhook 是一种用于从特定事件中检索和存储数据的工具。它们允许您注册 `https://` URL，事件数据可以采用 JSON 或 XML 格式存储在该 URL 中。Webhook 通常用于以下用途：

下单
更改产品价格
在您离线时通知您的 IM 客户端或寻呼机
为数据仓库收集数据
集成您的会计软件
筛选订单商品并通知各个发货公司有关此订单的信息
在客户卸载您的应用时从数据库中删除客户数据

本页相关主题

支持的 Webhook 事件

在创建 Webhook 时，您可以从列出的任何事件中进行选择。例如，如果您想创建在每次有订单付款时发送的 Webhook，请选择订单付款。再例如，如果您想创建在每次更新商店属性时发送的 Webhook，请选择商店更新。

列出了 Shopify 后台中可用的受支持 Webhook 事件的表格。
类别	事件
购物车	购物车创建购物车更新
结账	结账创建结账删除结账更新
产品系列	产品系列创建产品系列删除产品系列更新
客户	客户短信营销同意状态更新客户账户设置更新客户创建客户删除客户禁用客户电子邮件营销同意状态更新客户启用客户群组创建客户群组删除客户群组更新已添加客户标记已删除客户标记客户更新
折扣	折扣创建折扣删除折扣更新
草稿订单	草稿订单创建草稿订单删除草稿订单更新
发货	发货创建发货服务无法完成发货订单发货订单项目已准备好可供取货发货订单已移动发货订单已暂停发货订单已重新排程已排程的发货订单即将到期发货订单的订单路由已完成发货订单已取消发货订单取消请求已接受发货订单取消请求已拒绝发货订单取消请求已提交发货订单的发货请求已接受发货订单的发货请求已拒绝发货订单的发货请求已提交发货订单暂停已解除发货订单项目已准备好可供本地配送发货订单已合并发货订单已拆分发货更新
库存	库存商品创建库存商品删除库存商品更新库存水平关联库存水平取消关联库存水平更新
地点	地点激活地点创建地点停用地点删除地点商品更新
市场	市场创建市场删除市场更新
订单	订单取消订单创建订单删除订单编辑订单发货订单支付订单风险评估已更改订单更新
产品	产品创建产品删除产品更新
退款	退款创建
Shop	Shop 更新
付款方式	付款方式记录创建
模板	模板创建模板删除模板发布模板更新
交易	交易创建

创建 Webhook

您可以随时创建 Webhook。您的 Webhook 使用由字母和数字组合构成的 ID 进行签名，此 ID 对您的商店来说是唯一的。

步骤：

桌面版

在 Shopify 后台中，转至设置 > 通知。
点击 Webhook。
点击⊕ 创建 Webhook。
在事件下拉菜单中，选择要用作 Webhook 事件的任何受支持的 Webhook 事件。创建 Webhook 后，您将无法更改 Webhook 事件。
在格式下拉菜单中，选择您希望 Shopify 向您发送此信息时采用的格式。两个选项是 JSON 或 XML。
在 URL 字段中，输入要存储数据的 URL。Webhook 无法返回到以下 URL：
- Localhost
- 任何以单词“internal”结尾的 URL（例如 example.com/internal）
- 附加到商店的任何自定义域名中的任何 URL
- “虚假”域名（例如 www.example.com）
- Shopify 域名（例如 shopify.com 和 myshopify.com）
在 Webhook API 版本中，选择您的首选 Webhook 版本。
点击保存。

移动设备

在 Shopify app 中，轻触，然后轻触设置。
在商店设置部分，轻触通知。
轻触 Webhook。
轻触⊕ 创建 Webhook。
在事件下拉菜单中，选择要用作 Webhook 事件的任何受支持的 Webhook 事件。创建 Webhook 后，您将无法更改 Webhook 事件。
在格式下拉菜单中，选择您希望 Shopify 向您发送此信息时采用的格式。两个选项是 JSON 或 XML。
在 URL 字段中，输入要存储数据的 URL。Webhook 无法返回到以下 URL：
- Localhost
- 任何以单词“internal”结尾的 URL（例如 example.com/internal）
- 附加到商店的任何自定义域名中的任何 URL
- “虚假”域名（例如 www.example.com）
- Shopify 域名（例如 shopify.com 和 myshopify.com）
在 Webhook API 版本中，选择您的首选 Webhook 版本。
轻触保存或 ✓。

新 Webhook 保存后，它会显示在 Webhook 页面上。

编辑 Webhook

创建 Webhook 后，您可以编辑其配置。但是，您无法修改所选的 Webhook 事件。

步骤：

桌面版

在 Shopify 后台中，转至设置 > 通知。
点击 Webhook。
在包含要编辑的 Webhook 的行中，点击 ... > 编辑。
在编辑 Webhook 对话框中，根据需要修改 Webhook。
点击保存。

移动设备

在 Shopify app 中，轻触，然后轻触设置。
在商店设置部分，轻触通知。
轻触 Webhook。
在包含要编辑的 Webhook 的行中，轻触 ... > 编辑。
在编辑 Webhook 对话框中，根据需要修改 Webhook。
轻触保存或 ✓。

测试 Webhook

您可以测试 Webhook，以确保您需要的事件信息已发送到正确的 URL。

步骤：

桌面版

在 Shopify 后台中，转至设置 > 通知。
点击 Webhook。
在包含要测试的 Webhook 的行中，点击 ... > 发送测试。
在您为 Webhook 指定的 URL 处，验证通知是否正常工作。

移动设备

在 Shopify app 中，轻触，然后轻触设置。
在商店设置部分，轻触通知。
轻触 Webhook。
在包含要测试的 Webhook 的行中，轻触 ... > 发送测试。
在您为 Webhook 指定的 URL 处，验证通知是否正常工作。

删除 Webhook

您可以从 Shopify 后台删除 Webhook。此操作无法撤销。

步骤：

桌面版

在 Shopify 后台中，转至设置 > 通知。
点击 Webhook。
在包含要删除的 Webhook 的行中，点击 ... > 删除。

移动设备

在 Shopify app 中，轻触，然后轻触设置。
在商店设置部分，轻触通知。
轻触 Webhook。
在包含要删除的 Webhook 的行中，轻触 ... > 删除。