如何将Paddle连接到Shopify Flow

Paddle 是数字产品和订阅服务的记录商家。它会就交易、订阅、退款和客户信息变更向您发送通知。Workflow Webhooks 将该调用转换为 Shopify Flow 触发器,以便您的商店能够对此作出响应:为客户添加标签、添加订单备注、发送内部邮件、更新元字段 - - 凡是 Shopify Flow 能做到的操作均可实现。

本指南详细介绍了整个流程 - - Paddle 发送请求,Workflow Webhooks 接收并验证,Shopify Flow 进行处理 - - 每个请求都会验证 Paddle 的 HMAC 签名,因此只有 Paddle 才能启动您的工作流程。

你可以制作什么

  • 标记一位同时持有Shopify和Paddle订阅的客户,以便他们看到正确的定价或内容。
  • 当订阅被取消且客户近期有过 Shopify 的订单时,请向您的团队发送电子邮件。
  • 将当前套餐作为元字段写入客户记录中。

常见需发送的事件:transaction.completed、subscription.canceled、adjustment.created(退款)、customer.updated。

开始之前

  • Workflow Webhooks 已安装在您的 Shopify 商店上。
  • Shopify Flow 已安装,该应用可从Shopify应用商店免费下载。
  • 一个具有创建 Webhook 权限的 Paddle 账户。

步骤 1 - 在 Workflow Webhooks 上创建 Webhook

  1. 打开 Workflow Webhooks -> Webhook -> 创建 Webhook,并为其命名一个在 Shopify Flow 中能认出的名称,例如 Paddle events。
  2. 在**“身份验证**”下,选择 HMAC。
  3. 在**“签名提供商**”下,选择 Paddle。该应用会自动为您填写头部、算法、已签名负载和重放窗口 - - 无需进行其他配置。
  4. 暂时将“密钥”字段留空,然后点击“保存”。复制页面上显示的 Webhook URL。

有关其他身份验证模式,请参阅 身份验证;有关如何选择哪些字段会传输到 Shopify Flow,请参阅 负载映射和流变量。

步骤 2 - 在 Paddle 中添加端点

在 Paddle 中,打开**“开发者工具”→“通知**”,添加一个目标,输入您复制的 URL,然后选择相应事件。密钥会显示在该目标上。

如何查找您的 Paddle 签名密钥

通知目标的密钥(Paddle → 开发者工具 → 通知)。

Paddle 关于 Webhook 签名的官方文档 中,包含您账户的具体措辞和截图。

将该密钥粘贴到 Workflow Webhooks 页面中 Webhook 的**“Secret**”字段中,然后保存。从那时起,每条 Paddle 推送消息在到达 Shopify Flow 之前都会经过验证。

此处检查的内容

什么 值
签名页眉 Paddle-Signature
签名的位置 在该标头的h1值中,该值包含以分号分隔的key=value对
签署了什么 {timestamp}:{body}
签名 HMAC-SHA256,十六进制编码
时间戳 签名头中的ts值,单位为Unix秒
回放保护 签名时间戳与当前时间相差超过5分钟的请求将被拒绝
秘密 作为纯文本使用。请完全按照发件人显示的样式粘贴

在签名后的负载中,{body} 就是原始请求正文(按字节逐字节复制),而 {timestamp} 则是上文提到的时间戳。

如果请求未通过上述任何一项验证,则该请求将被以401状态码拒绝,并记录在历史与故障排除中,且绝不会启动工作流程。

步骤 3 - 构建Shopify Flow工作流程

  1. 在 Shopify Flow 中,创建一个工作流程,并选择“Workflow Webhooks”触发器。
  2. 点击**“记录事件**”,然后从 Paddle 发送一个测试事件(或使用 Workflow Webhooks 中的**“发送测试”功能**),以便 Shopify Flow 学习您的数据模式。
  3. 您拥有的每个 Webhook 都会触发相同的 Shopify Flow 触发器,因此请在 Webhook ID 上添加第一个条件,以确保此工作流程仅限于 Paddle。该 ID 显示在 Webhook 页面上。
  4. 添加操作 - - 标记客户、添加备注、发送内部邮件、更新元字段。
Shopify Flow
在Shopify Flow中,选择“Select a trigger”(选择触发器),打开Workflow Webhooks(应用程序),然后选择“Webhook Trigger”(Webhook 触发器)。
一个 Shopify Flow 条件:Webhook ID 等于某个 Webhook 的 ID
每个工作流程的第一步:基于 Webhook ID 的条件,确保工作流程仅针对此 Webhook 运行。
完成的工作流程:Webhook 触发器,基于 Webhook ID 的条件,然后在“True”分支上发送内部邮件
完成的工作流程:触发器、基于 Webhook ID 的条件,然后在“True”分支上执行您的操作。

第 4 步 - - 进行端到端测试

在 Paddle 中触发一个真实事件。在 Workflow Webhooks -> 历史记录 中,您应该能看到状态为“成功”的调用记录。如果签名有误,您会看到一条显示失败原因的记录;验证已签名的 Webhook 页面介绍了签名测试工具,该工具会精确显示哪个步骤失败了。

“History”中打开了一个调用,其中包含其请求头、负载、状态、持续时间和标识符
“History”中的已交付事件:状态为“成功”表示 Shopify Flow 已接受该事件。
签名不匹配▾

按以下顺序检查:密钥(最常见的原因 - - 多余的空格,或来自错误环境的密钥)、发送方是否使用了其他端点的密钥,以及Paddle与应用之间是否存在会重写请求体的环节。签名覆盖的是原始字节,因此会重新格式化JSON的代理会导致签名失效。 Webhook 页面上的签名测试工具会显示被签名的确切文本内容。

每次请求都会返回 401 错误▾

请确认 Webhook 的身份验证方式已设置为 HMAC,且已选择 Paddle 提供商;请确认已填写密钥;并请确认 Paddle 发送到该 URL 的请求内容与应用中显示的完全一致,包括末尾的代码。

“历史”中未显示任何内容▾

该请求从未送达。请在 Paddle 中重新检查 URL,并查看 Paddle 自身的投递日志,了解其收到的响应。若出现 404 错误,表示 Webhook 配置错误或已被删除;若出现 429 错误,则表示您已超出套餐的调用限制 - - 请参阅 套餐与使用情况。

工作流程针对错误的事件运行▾

您商店中的每个 Webhook 都会触发同一个 Shopify Flow 触发器。请在工作流程的第一步中添加一个基于 Webhook ID 的条件,或者缩小从 Paddle 发送的事件范围。

请求失败,错误信息为“时间戳超出容差范围”▾

Paddle 会在事件上添加时间戳,而该应用会拒绝任何超过 5 分钟的事件。这通常是发送端的时间同步问题,或者是 Paddle 在很久之后使用原始时间戳重试了该请求。来自同一原始请求的重试将无法通过;请让 Paddle 发送一个新的事件。

相关