如何將 Sentry 連接到 Shopify Flow

當問題被建立、指派、解決或觸發警示時,Sentry 可以通知整合服務。Workflow Webhooks 會將該呼叫轉為 Shopify Flow 觸發器,讓您的商店能據此採取行動:為客戶加上標籤、新增訂單備註、發送內部電子郵件、更新元資料欄位 - - 任何 Shopify Flow 能做的事,都能實現。

本指南闡述了整個流程 - - Sentry 發送請求、Workflow Webhooks 接收並驗證、Shopify Flow 執行操作 - - 且每項請求都會驗證 Sentry 的 HMAC 簽名,因此唯有 Sentry 才能啟動您的工作流程。

您可以打造什麼

  • 當結帳錯誤數量驟增時,請透過電子郵件將商店相關背景資訊發送給當值人員。
  • 將最後一次事件發生時間寫入主題可讀取的商店元資料欄位中。
  • 建立一個Shopify Flow,當發生關鍵警示時,該 會暫停促銷活動。

常見的觸發事件包括:建立問題、警示規則觸發、問題已解決。

開始之前

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

步驟 1 - 在 Workflow Webhooks 建立 Webhook

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

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

步驟 2 - 在 Sentry 中新增端點

在 Sentry 中,開啟您的 Integration Platform 應用程式,將 webhook URL 設定為您複製的 URL,啟用您想要的事件,並複製 Client Secret。

如何找出您的 Sentry 簽名密鑰

您 Sentry 整合的客戶密鑰。

Sentry 官方關於 webhook 簽名的文件 提供了您帳戶的具體說明文字與螢幕截圖。

將該密鑰貼入 Workflow Webhooks 中的 webhook**「Secret」**欄位,並儲存。從此之後,每則 Sentry 傳送的訊息在送達 Shopify Flow 之前都會經過驗證。

此處檢查的內容

什麼 價值
簽名標題 Sentry-Hook-Signature
簽名的位置 整個標頭值
簽署的內容為何 {body}
簽名 HMAC-SHA256,十六進位編碼
時間戳記 此寄件者未使用此功能
重播保護 無 - 此寄件者未對時間戳記進行簽名,因此每個有效的簽名仍保持有效
這個秘密 作為純文字使用。請完全按照發送者顯示的樣式貼上

在已簽署的載荷中,{body} 即是原始請求正文,逐位元組完全一致。

若請求未能通過上述任一項檢查,系統將以401狀態拒絕該請求,並將其記錄於歷史與故障排除中,且該請求絕不會啟動工作流程。

步驟 3 - 建立「Shopify Flow」工作流程

  1. 在 Shopify Flow 中,建立一個工作流程,並選擇「Workflow Webhooks」觸發器。
  2. 按下「記錄事件」,然後從 Sentry 發送一個測試事件(或透過 Workflow Webhooks 中的**「發送測試**」功能),讓 Shopify Flow 能學習您的數據模式。
  3. 您擁有的每個 Webhook 都會觸發相同的「Shopify Flow」觸發器,因此請在 Webhook ID 上新增第一個條件,以確保此工作流程僅限於 Sentry。該 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 - 進行端到端測試

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

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

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

每次發送請求都會收到 401 錯誤▾

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

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

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

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

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

相關