知識庫

將Webhook與HubSpot工作流程搭配使用

作者：HubSpot Support | Nov 21, 2022 11:56:22 AM

在工作流程中使用Webhook在HubSpot和其他外部工具之間傳送或擷取資訊。 Webhook有多種用途，常見的Webhook用例包括：

  • 當客服案件在您的網站上填寫特定表單時，將HubSpot客服案件資料發佈到另一個系統（如CRM ）。

  • 將交易數據發送到外部發貨處理系統以創建採購訂單。

  • 從其他系統擷取資料以更新您的HubSpot記錄。 

你可以使用工作流程發送POST和GET申請。 HubSpot將Webhook流量與其他工作流程分開管理。 這是為了簡化工作流程和Webhook效能。 當Webhook緩慢或逾時時，工作流程動作可能需要比預期更長的時間才能執行。

請注意： HubSpot將在失敗後一分鐘開始，最多三天內重試失敗的Webhook。 隨後的失敗將以增加的間隔重試，嘗試之間的最大間隙為8小時。 收到4XX系列回應狀態代碼後，工作流程將不會重試。
此規則的一個例外情況是429速率限制錯誤；工作流程將在收到429回應後自動重試，並且將尊重重試後標題（如果存在）。 Retry-After以毫秒為單位記錄。 瞭解HubSpot開發人員文件中的特定錯誤代碼例外情況。

深入瞭解開發人員Webhooks文件中的Webhooks。 如果您對HubSpot Webhook的具體實作有疑問，請透過HubSpot開發人員論壇聯絡我們。

設定發佈申請

  • 若要編輯現有的工作流程，請按一下工作流程的名稱。 或者，建立新的工作流程。
  • 在工作流程編輯器中，按一下+加號圖示以新增動作。
  • 在左側面板的「資料作業」部分中，選取「傳送Webhook」。
     

  • 點擊「方法」下拉式選單，然後選擇「發佈」。 
  • 輸入Webhook網址。
    • Webhook網址僅限於安全通訊協定，且必須以HTTPS開頭。
    • 若要請求特定資訊，您可以將查詢參數（例如?queryparameter=abc新增至Webhook URL。
    • 如果尚未新增查詢參數，系統會傳送一般POST或GET要求。 
  • 設定驗證類型，以驗證Webhook的請求。 您可以在Webhook標題中使用請求簽名，也可以使用API金鑰：
    • 若要在Webhook標頭中使用請求簽名，請按照以下步驟操作：
      • 點擊驗證類型下拉式選單。 然後，選取在標題中包含請求簽名。
      • 然後，輸入您的HubSpot應用程式ID。 了解如何驗證請求簽名。
    • 若要使用透過開發人員帳戶建立的API金鑰或公開應用程式進行驗證：
      • 使用API金鑰進行驗證時，所使用的API金鑰名稱和API金鑰位置 取決於Webhook的配置方式。 基於安全原因， API金鑰不會顯示在任何測試請求中。 若要使用API金鑰，請按照以下步驟
        • 點擊驗證類型下拉式選單。 然後，選擇API金鑰。 
        • 輸入您的API金鑰名稱。
        • 按一下API金鑰位置下拉式選單。 然後，選取Query參數或Request標頭。 深入瞭解如何在HubSpot中使用API金鑰。
      • 如果您向HubSpot API提出申請：
        • 點擊API金鑰下拉式選單，然後選擇一個密碼。 Secret值的格式必須為Bearer [YOUR_TOKEN]。
        • 將API金鑰名稱的值設定為「授權」。
        • 將API金鑰位置的值設定為Request Header。
  • 要包含所有屬性，請選擇包含所有[object]屬性。 
  • 若要僅包含特定屬性： 
    • 選取「自訂請求內文」。
    • 若要使用HubSpot屬性自訂要求內文，請輸入Key並選取屬性。 若要新增其他旅居，請按一下「新增旅居」。
    • 若要使用靜態欄位自訂請求內文，請輸入Key和Value。 若要新增其他屬性，請按一下新增靜態值。
    • 若要移除屬性或靜態值，請按一下delete 垃圾桶圖示。
  • 按一下儲存。 

請注意：若要選擇多個輸出，回應應結構化為JSON物件。


 


設定GET請求

  • 若要編輯現有的工作流程，請按一下工作流程的名稱。 或者，建立新的工作流程。
  • 在工作流程編輯器中，按一下+加號圖示以新增動作。
  • 在左側面板的「資料作業」部分中，選取「傳送Webhook」。
     

  • 按一下「方法」下拉式選單，然後選取「取得」。 
  • 輸入Webhook網址。
    • Webhook網址僅限於安全通訊協定，且必須以HTTPS開頭。
    • 若要請求特定資訊，您可以將查詢參數（例如?queryparameter=abc新增至Webhook URL。
    • 如果尚未新增查詢參數，系統會傳送一般POST或GET要求。 
  • 設定驗證類型，以驗證Webhook的請求。 您可以在Webhook標題中使用請求簽名，也可以使用API金鑰：
    • 若要在Webhook標頭中使用請求簽名，請按照以下步驟操作：
      • 點擊驗證類型下拉式選單。 然後，選取在標題中包含請求簽名。
      • 然後，輸入您的HubSpot應用程式ID。 了解如何驗證請求簽名。
    • 若要使用透過開發人員帳戶建立的API金鑰或公開應用程式進行驗證：
      • 使用API金鑰進行驗證時，所使用的API金鑰名稱和API金鑰位置 取決於Webhook的配置方式。 基於安全原因， API金鑰不會顯示在任何測試請求中。 若要使用API金鑰，請按照以下步驟操作：
        • 點擊驗證類型下拉式選單。 然後，選擇API金鑰。 
        • 輸入您的API金鑰名稱。
        • 按一下API金鑰位置下拉式選單。 然後，選取Query參數或Request標頭。 深入瞭解如何在HubSpot中使用API金鑰。
      • 如果您向HubSpot API提出申請：
        • 點擊API金鑰下拉式選單，然後選擇一個密碼。 Secret值的格式必須為Bearer [YOUR_TOKEN]。
        • 將API金鑰名稱的值設定為「授權」。
        • 將API金鑰位置的值設定為Request Header。
如果要設定GET要求，可以使用HubSpot屬性或新增靜態值作為查詢參數： 
  • 若要使用HubSpot屬性作為查詢參數：
    • 在「查詢參數」區段中，輸入金鑰，然後選擇屬性。
    • 若要新增其他旅居，請按一下「新增旅居」。
    • 若要移除旅居，請按一下「delete 垃圾桶」圖示。 
  • 若要使用靜態值作為查詢參數：
    • 在「查詢參數」區段中，輸入Key ，然後輸入值。
    • 若要新增其他屬性，請按一下新增靜態值。
    • 若要移除旅居，請按一下「delete 垃圾桶」圖示。 
  • 按一下儲存。 


在HubSpot中測試Webhook


設定文章或取得Webhook時，您可以執行測試以檢視Webhook回應。 在測試期間，當數據發送給第三方並從第三方擷取時， HubSpot中的現有記錄將不會受到影響。 如果您使用API金鑰進行驗證，則API金鑰不會顯示在任何測試請求中。

測試Webhook後，您可以選擇要輸出的欄位，以便稍後在工作流程中用作輸入。 僅選擇每個回應中可用的輸出。 如果輸出在稍後的動作中使用，但在回應中不可用，則該動作將失敗。 

  • 按一下工作流程的名稱。 
  • 在工作流程編輯器中，按一下傳送Webhook動作。
  • 在左側面板中，按一下測試動作以展開部分。 
  • 如果你正在測試發佈申請，請點擊[object]下拉式選單，然後選擇要測試的紀錄 。
  • 按一下測試。 
  • 若要檢查Webhook詳細資訊，請選取「回應」或「要求」索引標籤。 在每個標籤上，您可以按一下「全部開啟」展開所有區段，或按一下「全部折疊」折疊所有區段。 
    • 在「回應」索引標籤中，按一下標題：或內文：以展開每個區段。 
    • 在「請求」索引標籤中，按一下httpHeaders:以展開區段。

從外部測試Webhook

使用Webhook動作建立工作流程後，您可以使用虛擬Webhook URL執行快速測試：

  • 在瀏覽器中，前往https://webhook.site並複製唯一網址。
  • 在Webhook操作的Webhook URL欄位中，貼上URL。
  • 開啟工作流程後，您可以手動註冊測試客服案件。 

  • 外部測試Webhook

    時：

    • 如果觸發具有POST要求的Webhook動作，則會將JSON回應正文傳送到Webhook ，其中包含聯絡人的所有資訊，包括表單提交、清單成員資格和所有聯絡人屬性值。 然後，接收系統可以解析JSON資料，並將其用於自己的應用程式。
    • 如果觸發具有GET要求的Webhook動作，除非已套用其他查詢參數，否則將傳送一般GET要求。 

請注意：歷史旅居價值只會在客服案件工作流程中傳回。 所有其他工作流程類型中使用的Webhook只會傳回最新的值。

驗證工作流程Webhook中的請求簽名

當您在「觸發webhook動作」的「驗證」部分中選擇「請求簽名」時， HubSpot將使用X-HubSpot-Signature標頭填入Webhook ，其中包含應用程式、HTTP方法、URI和未解析正文的應用程式機密串聯的SHA-256雜湊。 請參閱開發人員文件，深入瞭解相關資訊。

若要驗證您的網址收到的請求是否來自HubSpot ：

從Webhook觸發工作流程

Webhook可用於觸發工作流程。 當第三方應用程式中的資料變更時，可能會觸發工作流程。 深入瞭解如何從Webhook觸發工作流程。

在數據面板中使用Webhook數據

連接到您帳戶的Webhook中的資料可用於資料面板中的某些操作。

若要使用已連線的Webhook中的資料：

  • 按一下工作流程的名稱。
  • 按一下+加號圖示以新增動作。
  • 在左側面板中，選擇使用資料面板 的操作 。
  • 在資料面板中，按一下檢視屬性或下拉式功能表中的動作輸出，然後選取Webhook觸發器。 然後，您可以使用已連接的Webhook中的屬性。
     

 
檢視完整文章