跳至正文
帮助
简体中文
商店设置

Webhooks

配置实时事件通知,当您商店中发生会话、订单或订单更新时,将通知发送至 API 端点或电子邮件地址。

Webhooks 的功能

Webhook 是对特定商店事件的订阅。当该事件发生时,Storeep 立即将事件数据发送至您指定的 URL(API 类型)或您指定的电子邮件地址(电子邮件类型)。Webhooks 常用于订单追踪集成、CRM 同步、广告平台转化追踪和自动化通知。

要管理 Webhooks,请进入 设置 → Webhooks

Webhook 限制

  • 每个商店最多 20 个 Webhooks,尝试添加第 21 个将返回错误。
  • Webhooks 按最新排列,每页 40 条。

创建 Webhook

点击添加新 Webhook

激活开关

勾选(默认),Webhook 从保存时即刻生效,事件立即派送。取消勾选可在禁用状态下保存 Webhook,不接收事件。您可以随时通过编辑启用或禁用 Webhook。

名称

  • 必填。
  • 最多 50 个字符
  • 在 Webhooks 列表中显示的描述性标签。例如:Facebook CAPI,订单已创建

类型

控制事件有效载荷的传送方式,有两个选项:

  • API:Storeep 向您指定的 URL 发送包含事件数据的 HTTP POST 请求。
  • 电子邮件:Storeep 向您指定的地址发送包含事件数据的电子邮件。

事件

触发此 Webhook 的商店事件,提供三种事件:

  • 会话已创建:商店中新访客会话创建时触发。
  • 订单已创建:新订单下单时触发。
  • 订单已更新:现有订单的状态或数据发生变化时触发。

格式

事件有效载荷的数据格式,目前只有一个选项:

  • Json:有效载荷以 JSON 文档形式发送。

URL(仅 API 类型)

  • 类型为 API 时必填。
  • 最多 500 个字符,更大的限制可容纳包含多个占位符段的 URL。
  • 输入端点 URL 时不要包含 https:// 前缀,系统会自动添加。例如:api.example.com/events/order
  • 动态 URL 占位符:事件有效载荷中的任何字段都可以使用双花括号语法注入到 URL 中:{{field_name}}。例如:
    https://example.com/postback?cid={{fbclid}}&payout={{order_total}}
    这让您可以直接从 Webhook URL 向广告平台发送转化数据,无需单独的代理服务器。
  • 如果占位符解析后 URL 结构无效,您将收到验证错误。

电子邮件地址(仅电子邮件类型)

  • 类型为电子邮件时必填。
  • 必须是有效的电子邮件地址,最多 127 个字符。

编辑 Webhook

点击任意 Webhook 行打开编辑器,所有字段均可编辑。URL 字段仅在当前类型为 API 时预填;电子邮件字段仅在当前类型为电子邮件时预填。切换类型将清除另一个字段。

启用和禁用 Webhooks

编辑器顶部的激活复选框控制 Webhook 是否触发。列表中的状态显示已激活已停用。禁用的 Webhook 不记录任何派送记录,但不会被删除,因此您可以在之后重新启用而无需重新配置。

Webhooks 列表的列

  • 名称:Webhook 标签及创建日期。
  • URL / 电子邮件:目标地址。
  • 类型:API电子邮件
  • 事件:事件名称(会话已创建订单已创建订单已更新)。
  • 格式:Json
  • 状态:已激活已停用

删除 Webhook

选择一个或多个 Webhooks,点击删除 Webhooks,这是永久性操作,将停止该订阅的所有未来派送。

提示与注意事项

  • 您可以为同一事件创建多个 Webhooks,例如,将订单已创建分别发送至 CRM 和广告平台,各自作为独立的 Webhook 条目。
  • 如果您的端点需要身份验证,请使用来自事件数据的 {{placeholder}} 将凭证添加到 URL 查询字符串中,或设置代理服务器在转发至真实端点前处理身份验证。
  • 会话已创建事件会在每个唯一访客会话时触发,对于热门商店来说可能是高流量的。只有当您的端点能够处理该吞吐量时,才订阅此事件。