如何将 Vercel 连接到 Shopify Flow

当创建部署、部署成功、部署失败,或者项目或域名发生变更时,Vercel 会发送一个 Webhook。Workflow Webhooks 会将该调用转换为 Shopify Flow 触发器,从而让您的商店能够对此作出响应:给客户打上标签、添加订单备注、发送内部邮件、更新元字段 - - 任何 Shopify Flow 能做的事情。

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

你可以制作什么

  • 当无头店面部署失败时,请向团队发送电子邮件。
  • 每次部署成功后,将生产环境部署 ID 写入商店元字段中。
  • 部署准备就绪后,启动缓存预热或重新索引工作流程。

常见的发送事件包括:deployment.succeeded、deployment.error、project.created。

开始之前

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

步骤 1 - 在 Workflow Webhooks 上创建 Webhook

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

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

步骤 2 - 在 Vercel 中添加端点

在 Vercel 中,打开**“设置”→“Webhook”**(针对团队或项目),使用您复制的 URL 创建一个 Webhook,并复制系统显示的密钥。

如何查找您的 Vercel 签名密钥

创建 Webhook 时显示的 Webhook 密钥(或该集成的客户端密钥)。

Vercel 关于 Webhook 签名的官方文档 中,提供了您账户的具体说明和截图。

将该密钥粘贴到 Workflow Webhooks 中的 Webhook“Secret”字段中,然后保存。从那时起,每次 Vercel 的部署在到达 Shopify Flow 之前都会经过验证。

此处检查的内容

什么 值
签名页眉 x-vercel-signature
签名的位置 整个标头值
签署了什么 {body}
签名 HMAC-SHA1,十六进制编码
时间戳 此发件人未使用该功能
回放保护 无 - - 该发件人未对时间戳进行签名,因此所有有效的签名均保持有效
秘密 作为纯文本使用。请完全按照发件人显示的内容粘贴

在已签名的负载中,{body} 就是原始请求正文,字节对字节完全一致。

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

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

  1. 在 Shopify Flow 中,创建一个工作流程,并选择“Workflow Webhooks”触发器。
  2. 点击**“记录事件**”,然后从 Vercel 发送一个测试事件(或使用 Workflow Webhooks 中的**“发送测试”功能**),以便 Shopify Flow 学习您的数据结构。
  3. 您拥有的每个 Webhook 都会触发同一个 Shopify Flow 触发器,因此请在 Webhook ID 上添加第一个条件,以确保此工作流程仅限于 Vercel。该 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 步 - - 进行端到端测试

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

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

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

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

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

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

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

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

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

相关