如何將 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 App Store 免費下載。
  • 一個具備建立 Webhook 權限的 Vercel 帳戶。

步驟 1 - 在 Workflow Webhooks 建立 webhook

  1. 開啟 Workflow Webhooks → Webhooks → 建立 Webhook,並為其命名一個您在 Shopify Flow 中能認出的名稱,例如 Vercel events。
  2. 在「驗證」下,選擇 HMAC。
  3. 在「**簽名提供者」**下,選擇 Vercel。應用程式會自動為您填入標頭、演算法、簽名載荷及重播視窗 - - 無需進行其他設定。
  4. 目前請將「密鑰」欄位留空,然後按下「儲存」。複製頁面上顯示的 Webhook URL。

有關其他驗證模式,請參閱 驗證;若要選擇哪些欄位會傳送至 Shopify Flow,請參閱 有效載荷映射與 Shopify Flow 變數。

步驟 2 - 在 Vercel 中新增端點

在 Vercel 中,開啟**「設定」→「Webhooks」頁面**(針對該團隊或專案),使用您複製的 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 中,選擇「選取觸發器」,開啟「Workflow Webhooks」,然後選擇「Webhook 觸發器」。
Shopify Flow 條件:Webhook ID 等於某個 Webhook 的 ID
每個工作流程的第一個步驟:針對 webhook ID 設定一個條件,以便工作流程僅針對此 webhook 執行。
完成的工作流程:Webhook 觸發器、基於 Webhook ID 的條件,接著在「True」分支上發送內部電子郵件
完成的工作流程:觸發器、基於 webhook ID 的條件,接著在「True」分支上執行您的動作。

步驟 4 - 進行端到端測試

在 Vercel 中觸發一個真實的事件。在 Workflow Webhooks → 歷史紀錄 中,您應該會看到狀態為**「成功」**的呼叫記錄。如果簽名不正確,您會看到一個標示失敗的記錄並附上原因;而 驗證已簽名的 Webhook 則說明了簽名測試工具,該工具會精確顯示哪個步驟失敗。

「歷史」中開啟了一項呼叫,其中包含其請求標頭、有效載荷、狀態、持續時間及識別碼
「History」中的已傳送事件:狀態為「成功」表示 Shopify Flow 已接受該事件。
簽名不符▾

依此順序:密鑰(最常見的原因 - - 多餘的空格,或是來自錯誤環境的密鑰)、發送者是否使用了不同端點的密鑰,以及 Vercel 與應用程式之間是否有任何環節重寫了請求正文。簽名涵蓋原始位元組,因此若代理伺服器重新格式化了 JSON,便會破壞簽名。 Webhook 頁面上的簽名測試工具會顯示實際經過簽名的精確文字內容。

每次請求都會出現 401 錯誤▾

請確認 webhook 的驗證方式已設定為 HMAC 且已選取 Vercel 提供者,密鑰欄位已填入,並且 Vercel 傳送至該 URL 的內容完全與應用程式顯示的一致,包括結尾處的代碼。

「歷史」中沒有任何記錄▾

該請求從未送達。請在 Vercel 中重新檢查 URL,並查看 Vercel 自身的傳送日誌,確認其收到的回應。若出現 404 表示 webhook 錯誤或已被刪除;若出現 429 則表示您已超過方案的呼叫次數限制 - - 請參閱 方案與使用方式。

工作流程針對錯誤的事件執行▾

您商店中的每個 Webhook 都會觸發相同的「Shopify Flow」觸發器。請在工作流程的第一步中,針對 Webhook ID 新增一個條件,或者篩選您從 Vercel 傳送的事件。

相關