如何將 Paddle 連接到 Shopify Flow

Paddle 是數位產品與訂閱服務的「記錄商」(Merchant of Record)。它會通知您有關交易、訂閱、退款及客戶資料變更等資訊。Workflow Webhooks 會將此通知轉為 Shopify Flow 觸發器,讓您的商店能據此採取行動:為客戶加上標籤、新增訂單備註、發送內部電子郵件、更新元資料欄位 - - 凡是 Shopify Flow 能做到的,都能實現。

本指南設定了完整的流程 - - 由 Paddle 發送請求、Workflow Webhooks 接收並驗證,Shopify Flow 進行處理 - - 且每項請求都會驗證 Paddle 的 HMAC 簽名,因此唯有 Paddle 才能啟動您的工作流程。

您可以打造什麼

  • 請標記一位同時持有 Paddle 訂閱服務的 Shopify 客戶,以便他們看到正確的價格或內容。
  • 當訂閱被取消,且客戶近期有過 Shopify 的訂單時,請透過電子郵件通知您的團隊。
  • 將當前的方案以元欄位的形式記錄在客戶檔案中。

常見的發送事件包括:transaction.completed、subscription.canceled、adjustment.created(退款)、customer.updated。

開始之前

  • Workflow Webhooks 已安裝在您的 Shopify 商店中。
  • Shopify Flow 已安裝,此應用程式可從 Shopify App Store 免費下載。
  • 一個具備建立 Webhook 權限的 Paddle 帳戶。

步驟 1 - 在 Workflow Webhooks 建立 Webhook

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

有關其他驗證模式,請參閱 驗證;關於如何選擇哪些欄位會傳送至 Shopify Flow,請參閱 有效載荷映射與 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 中,選擇「選取觸發器」,開啟「Workflow Webhooks」,並選擇「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 傳送新的事件。

相關