跳到主要内容

在 WooCommerce 中使用 Webhook

什么是 Webhook？​

一个 Webhook 是一种事件通知，发送到您选择的 URL。 用户可以配置它们，以便在一个站点的事件触发另一个站点的行为。

Webhook 对于与第三方服务和其他支持它们的外部 API 集成非常有用。

WooCommerce 中的 Webhook​

Webhook 在 WooCommerce 2.2 中引入，可以在您添加、编辑或删除订单、产品、优惠券或客户时触发事件。

您还可以使用 Webhook 与 WooCommerce 的操作结合使用，例如，创建一个 Webhook，以便在每次将产品添加到购物车时触发，使用操作 woocommerce_add_to_cart。

Webhook 还可以使第三方应用程序更容易与 WooCommerce 集成。

创建 Webhook​

WebHooks 界面

要创建新的 Webhook：

1/ 转到: WooCommerce > 设置 > 高级 > Webhook。

注意： 在 WooCommerce 3.4 之前，Webhook 位于 WooCommerce > 设置 > API 下。

2/ 选择 创建新的 Webhook (首次创建) 或 添加 Webhook。 Webhook 数据 框将出现。

WebHooks 创建

3/ 输入：

  • 名称: 名称 会自动生成为 "Webhook created on [创建日期和时间]"，作为标准，以方便创建。 将名称更改为其他名称。
  • 状态: 设置为 活动 (发送数据)，暂停 (不发送数据)，或 禁用 (由于发送失败而不会发送数据)。
  • 主题: 指示何时触发 Webhook - 订单创建，产品删除，或 客户更新。 还有 操作 和 自定义 选项。
    • 操作事件: 当主题是 WooCommerce 操作 时，此选项可用，例如 woocommerce_add_to_cart，表示当客户将产品添加到购物车时。
    • 自定义主题: 此选项仅适用于 高级用户。 您可以使用 woocommerce_webhook_topic_hooks 过滤器引入新的、自定义的主题。
  • 传递 URL: Webhook 数据传递到的 URL。
  • 密钥: 密钥生成传递的 Webhook 的哈希值，并在请求头中提供。 如果未输入任何内容，则默认为当前 API 用户的消费者密钥。

4/ 保存 Webhook。

注意： 首次以“已激活”状态保存 Webhook 时，它会将一个 ping 发送到传递 URL。

如果传递 URL 返回不成功的状态，例如 404 或 5xx，Webhook 默认情况下会尝试 5 次后被禁用。 成功的响应是 2xx、301 或 302。

要增加重试次数，可以使用 woocommerce_max_webhook_delivery_failures 过滤器函数。

编辑和删除 Webhook​

Webhook 的显示方式与帖子或产品相同。

  1. 查找 您想要修改的 Webhook。
  2. 将鼠标悬停在名称上，会显示 编辑 和 永久删除 选项。
  3. 删除，或进行 编辑 并 保存 修改。 还可以通过下拉菜单进行批量删除。

Webhook 删除

Webhook 日志​

WooCommerce 会保存所有触发 Webhook 的事件的日志。 Webhook 日志位于：WooCommerce > 状态 > 日志。

Webhook 日志

可以查看日志以了解服务器的响应和状态，这有助于简化集成和 调试。