README

(更新) 2023-02-02：此项目将被标记为付费项目，并将不再免费维护。有关进一步更新和技术支持，请关注Magento 2 Webhook 扩展以获取更多信息。我们理解这种变化可能给我们的用户带来不便。但是，这是为了确保该模块能够更新，以支持更好的 Magento 2 店铺。如果您对任何功能有任何担忧或想法，请不要犹豫，通过联系我们并留下请求。

Mageplaza Webhook for Magento 2 支持在线商店在特定触发事件发生时通过 webhook 向可配置的目的地（URL）发送 API 请求。Webhook 是一个非常有用且必要的工具，它允许商店发送即时和实时的通知。

重要提示：GitHub 上的 Mageplaza Webhook 扩展版本免费，作为 Mageplaza 对 Magento 社区的贡献。此软件包不包括技术支持。如果您需要此扩展的技术支持，您将不得不从 Mageplaza 购买许可证。点击此处购买。

1. Webhook 文档

2. Webhook 常见问题解答

问题：我收到错误：Mageplaza_Core 已经定义过

答案：阅读解决方案此处

问题：我如何设置弃购购物车的时长？

答案：这可以轻松地从管理员后台完成。时间将以小时计算。

问题：我正在使用 CRM 系统。此扩展支持向此系统发送数据吗？

答案：是的，绝对支持。您只需创建具有您想要发送到 CRM 的特定触发事件的钩子，然后从管理员后台插入 CRM 负载 URL。

问题：如果一个钩子的请求失败，我如何获得通知？

答案：请启用“错误警报”功能，并添加您希望收件人的电子邮件地址。

3. 如何安装 Magento 2 的 Webhook 扩展

在 Magento 2 根目录中运行以下命令

带有营销自动化（推荐）

composer require mageplaza/module-webhook mageplaza/module-smtp
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

不带营销自动化

composer require mageplaza/module-webhook
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

4. Magento 2 Webhook 突出功能

在特定事件发生时发送 API 请求

Mageplaza Webhook 模块可以快速检测商店的任何更新，并在特定事件发生时立即向其他服务器或应用程序发送 API 请求。可以基于以下事件创建钩子：

新订单/发票/装运/贷项单
新订单评论
新/更新/删除客户
新/更新/删除产品
新/更新/删除类别
客户登录
弃购购物车

在购物车弃购发生时发送 API 请求

Webhook 的一个典型特性是允许在购物车弃购发生时发送通知。

这对于需要跟进客户行为的销售和客户关怀部门的商店来说非常实用。

将潜在客户/客户数据发送到CRM或电子邮件营销工具

Webhook是电子商务业务中CRM或电子邮件营销系统的辅助工具。客户数据、订单或任何相关更新的数据需要即时发送到这些系统。然后，商店可以快速安排相应的销售行动。

记录请求和响应

通过钩子日志可以快速更新钩子的状态和错误消息。管理员可以轻松预览日志ID的响应。

5. 更多功能

发送警报

通过电子邮件发送错误请求的通知。

自动清除日志

当总数达到特定数量时，每天清理日志。

重新发送请求

修复错误后，重新发送替换后的请求。

6. 完整的Magento 2 Webhook功能

常规配置

启用/禁用模块
设置发送遗弃购物车通知的时间
当出现错误时发送警报电子邮件
选择电子邮件模板
设置日志总数
每天清理日志

管理钩子

为新的钩子设置名称
为钩子设置状态、商店视图、优先级
输入有效载荷URL
选择发送请求的方法
输入钩子的头信息
选择4个选项中的内容类型
将变量插入正文并预览
通过网格管理钩子

钩子日志

查看所有日志的状态、实体、消息
查看日志的错误消息
选择日志的操作：预览响应或重播（使用固定日志）

7. Webhook用户指南

7.1 如何配置Magento 2 Webhook

登录到 Magento管理后台，选择 商店 > 设置 > 配置 > Mageplaza扩展 > Webhook。

启用：选择 是 以启用模块，选择 否 以禁用。
遗弃购物车后（分钟）：设置遗弃购物车的分钟数。建议时间段：1，6，10，12，24
保留日志：当达到此数量时，将自动清理日志。这将在每天完成。
错误时警报：选择“是”通过电子邮件发送错误通知。为了避免发送到垃圾箱，应安装SMTP。

发送到：输入接收错误通知的电子邮件地址。
电子邮件模板：按照 营销 > 电子邮件模板 > 添加新模板 创建您想要的模板。您可以选择默认Mageplaza Webhook电子邮件模板（默认）。

7.2 管理钩子

网格

从 管理员面板，转到 Mageplaza > Webhook > 管理钩子。

网格包括主要的钩子信息：名称、状态、商店视图、实体、创建日期和更新日期...
管理员可以选择操作
- 删除：删除一个钩子
- 更改状态：选择 启用 以激活钩子。
- 编辑：编辑钩子信息。
此外，管理员可以在网格中更改状态、商店视图。
选择 添加新 按钮以选择 触发事件（新订单、新产品、更新产品、删除产品等）以创建新钩子并发送到其他服务器。

创建钩子

选择 触发事件（新订单、新产品、更新产品、删除产品等）以创建新钩子

名称：为新钩子设置名称。当向客户发送电子邮件时将使用此名称。
状态：选择“启用”以激活钩子。
商店视图：选择钩子显示的商店视图。
优先级：为钩子设置优先级。数字越小，优先级越高。

负载URL:
- 选择插入变量按钮来插入变量。例如：方法 POST：https://domain.freshsales.io/api/leads，GET：https://domain.freshsales.io/leads/view/4000831345 或 https://domain.freshsales.io/leads/view/4000831345 new_shipment={插入的变量}
- 域名是API账户名称。要注册API账户，请点击链接：https://www.freshworks.com/freshsales-crm/。了解更多关于API的信息这里。
- 这是必填字段，不允许留空
方法：选择发送HTTP请求的方法。如果留空，默认方法将是GET
- GET：从服务器获取数据
- POST：创建新对象
- PUT：更新对象
- DELETE：删除对象。
- HEAD：与GET相同，但不需要主体。
- CONNECT：将请求的连接转换为透明的TCP/IP隧道，通常用于通过未加密的HTTP代理进行SSL加密（HTTPS）。
- OPTIONS：描述选项。一个OPTIONS请求应返回描述服务器在特定URL上支持的其他方法和操作的资料。
- TRACE：重复请求，以便客户可以看到任何中间服务器所做的更改或添加（如果有）。
- PATCH：将修改的部分应用于对象。
认证：选择您希望从服务器获取的数据访问认证类型。在提交请求时，通常需要包括参数以确保请求具有访问权限并返回您想要的数据。您应该留空此字段以限制访问。

- **Basic**: Display 2 Username and Password fields. Fill in the information to authenticate access.
- **Note**: In the process of being strictly enforced throughout the entire data cycle to SSL for security, authentication is transmitted over unsafe lines.
- **Digest**: Fill out some credentials below:

头部：点击添加按钮，添加API被视为的头部值，如名称和值。例如，名称是Authorization，值是Token token=“您的API密钥”
内容类型：选择要发送的数据的内容类型。对于GET方法，您可以留空此字段。

主体：对于POST或PUT等方法，您需要在主体部分添加内容以发送请求。点击插入变量以选择变量。

7.3 钩子日志

从管理员面板，转到Mageplaza > Webhook > 日志

本节将记录Webhooks变更日志，如名称、状态、实体、消息等。

查看日志

点击查看以查看日志详情

安装指南库

您需要运行以下命令来安装库

composer require liquid/liquid

许可证

从2019年6月23日起，本扩展受MIT许可证许可，您可随意分支并开发此模块。

人们也搜索

magento webhooks
magento 2 webhooks
magento webhook
magento 2 webhook
magento 2 hooks
magento webhook integration
magento 2 webhook integration

maxvscode/module-webhook

维护者

详细信息