Webhook介绍
Last updated
Last updated
Webhook 是一个API 概念,是微服务 API 的使用范式之一,适用于商店发生特定事件后执行代码的应用程序。避免了应用程序定期轮询特定事件。每当事件发生时,都会主动向端点发送一个webhook。
说明 | 请求方法 | 接口地址 |
获取 Webhook 列表 | GET | /openapi/2021-08/webhooks |
获取 Webhook 数量 | GET | /openapi/2021-08/webhooks/count |
获取指定 Webhook | GET | /openapi/2021-08/webhooks/{id} |
创建 Webhook | POST | /openapi/2021-08/webhooks |
更新 Webhook | PUT | /openapi/2021-08/webhooks/{id} |
删除 Webhook | DELETE | /openapi/2021-08/webhooks/{id} |
首次发送失败后,按以下规则重发:
1分钟、5分钟、10分钟、30分钟、1小时、2小时。后续都以2小时为间隔发送,直到重发19次。
每5次发送一次告警邮件,最后一次失败后发送 webhook 删除提示邮件。
我们目前已支持的事件列表:
事件对象 | 事件 | 说明 |
Checkout | checkouts/create | v1.28已支持 |
checkouts/update | v1.28已支持 | |
checkouts/delete | v1.28已支持 | |
Collection | collections/create | v1.25 已支持 |
collections/update | v1.25 已支持 | |
collections/delete | v1.25 已支持 | |
Customer | customers/create | 1.27 已支持 |
customers/update | 1.27 已支持 | |
customers/delete | 1.27 已支持 | |
Order | orders/cancelled | v1.23 已支持 |
orders/cancel_refunded | 1.27 已支持 | |
orders/paid | v1.20 已支持 | |
orders/refunded | v1.23 已支持 | |
orders/created | v1.43已支持 | |
orders/updated | v1.43已支持 | |
Product | products/create | v1.21 已支持 |
products/update | v1.21 已支持 | |
products/delete | v1.21 已支持 | |
Shop | app/uninstalled | v1.20 已支持 |
shop/update | 1.26 已支持 | |
Theme | themes/create | 1.27 已支持 |
themes/publish | 1.27 已支持 | |
themes/update | 1.27 已支持 | |
themes/delete | 1.27 已支持 | |
Domain | domains/update | v1.27已支持 |
Price Rules | price_rules/update | v1.27已支持 |
price_rules/create | v1.27已支持 | |
price_rules/delete | v1.27已支持 | |
Stock | stocks/update | v1.39已支持 |