WooCommerce Webhook

Webhook让WooCommerce商店自动向指定URL发送事件通知。本指南介绍Webhook的含义、如何创建和管理它们，以及如何查看投递日志进行故障排查。

什么是 Webhook

Webhook是发送到指定URL的事件通知。你或开发者可以配置它，使一个网站发生的事件触发另一个网站的相应行为。

Webhook适合把商店与支持它的第三方服务或其他外部API集成。

WooCommerce 中的 Webhook

添加、编辑或删除订单、产品、优惠券或客户，以及发生购买等事件时，WooCommerce都可以触发Webhook通知。

支持范围：

根据WooCommerce的支持政策，官方不为定制内容提供支持。如果需要调整代码片段或扩展功能，官方建议与Woo Agency Partner合作，或在Codeable寻找WooCommerce开发者。

Webhook也可以与WooCommerce动作配合。例如，使用woocommerce_add_to_cart动作，可以在产品每次加入购物车时触发Webhook。

Webhook也使第三方应用能够与WooCommerce集成。

创建 Webhook

创建新Webhook的步骤如下：

1. 进入WooCommerce > Settings > Advanced > Webhooks（设置 > 高级 > Webhook）。
2. 选择Add webhook，页面会显示Webhook data表单。

1. 填写以下字段：

   • Name（名称）：输入描述。留空时，默认名称为“Webhook created on [date and time]”，即创建日期和时间。以后可以修改名称。
   • Status（状态）：Active表示投递通知；Paused表示临时暂停；Disabled表示因投递失败而停止。

   • Topic（主题）：选择触发事件，可选内容包括优惠券、客户、订单、产品相关事件以及Action。根据商店启用的扩展，也可能出现其他主题。

     • Custom Topic（自定义主题）：仅供高级用户使用，可以通过woocommerce_webhook_topic_hooks过滤器添加自定义主题。
   • Action Event（动作事件）：主题选为Action时显示。填写触发Webhook的动作，例如客户把产品加入购物车时触发的woocommerce_add_to_cart。
   • Delivery URL（投递URL）：接收Webhook负载的URL。
   • Secret（密钥）：用于为投递的Webhook生成哈希值，哈希包含在请求头中。留空时，默认使用当前API用户的consumer secret。
2. 点击Save webhook保存。

注意：首次以Active状态保存Webhook时，WooCommerce会向Delivery URL发送一次ping。

自动禁用

Webhook连续投递失败超过五次后，WooCommerce会自动将其禁用。任何不是2xx、301或302的HTTP响应都算失败，例如4xx与5xx响应。

可以通过woocommerce_max_webhook_delivery_failures过滤器调高或调低失败阈值。

编辑与删除 Webhook

在WooCommerce > Settings > Advanced > Webhooks列表中，可以编辑或删除现有Webhook。

1. 找到需要修改的Webhook。
2. 把指针悬停在名称上，可看到ID、Edit和Delete permanently选项。
3. 选择Delete permanently会永久删除；选择Edit可调整设置，再点击Save webhook保存。

批量删除时，先用复选框选中多个Webhook，再从Bulk actions下拉菜单选择Delete permanently。

Webhook 日志

WooCommerce会记录触发Webhook的所有事件。日志可用于确认投递结果、查看接收服务器的响应，便于集成与调试。

查看日志的步骤：

1. 进入WooCommerce > Status > Logs（状态 > 日志）。
2. 日志文件较多时，在All sources下拉菜单中选择webhooks-delivery进行筛选。
3. 使用右上角搜索框搜索日志内容。

问题与支持

如果仍有问题、需要帮助，可使用以下支持渠道。

本说明针对免费的WooCommerce核心插件，其支持由WordPress.org社区论坛提供。搜索论坛时，通常可以找到他人已经提出并得到回答的相同问题。如果还没有用于论坛的WordPress.org账户，可参见注册说明。

• 若要扩展本文介绍的核心功能，建议查看WooCommerce Marketplace中的扩展。
• 如需持续的高级支持或定制开发，可聘请Woo Agency Partner。
• 如果正在开发自己的WooCommerce集成或扩展，可查看Developer Resources。

如果仍未找到需要的信息，可以前往原文页面，通过底部反馈按钮告知文档维护者。

正文相关链接

• What are webhooks
• Webhooks in WooCommerce
• Support Policy
• Create a webhook
• Automatic disabling
• Edit and delete webhooks
• Webhook logs
• Questions and support
• community forums on WordPress.org
• core WooCommerce plugin
• here’s how