跳到內容
請注意::這篇文章的翻譯只是為了方便而提供。譯文透過翻譯軟體自動建立,可能沒有經過校對。因此,這篇文章的英文版本應該是包含最新資訊的管理版本。你可以在這裡存取這些內容。
Workflows

使用Webhooks與HubSpot工作流

上次更新時間: 十一月 21, 2022

套用至:

Operations Hub Professional, Enterprise

在工作流程中使用webhook來在HubSpot和其他外部工具之間發送或檢索資訊。 Webhooks有多種用途, Webhooks的常用用例包括:

  • 當聯絡人填寫網站上的特定表單時,將HubSpot聯絡人資料張貼到另一個系統(如CRM )。

  • 將交易資料傳送到外部貨運處理系統以建立購買訂單。

  • 從外部系統向公司的聊天串流發送聊天提醒,通知員工發生了重要事情。

  • 正在從其他系統檢索資料,以更新您的HubSpot記錄。 

您可以使用工作流程發送帖子和GET請求。 HubSpot將Webhook流量與其他工作流程分開管理。 這是為了簡化工作流程和webhook性能。 當webhook速度慢或超時時,工作流程操作可能需要比預期長的時間來執行。

請注意: HubSpot將在失敗後的一分鐘內重試失敗的webhook ,最多為三天。 後續失敗將以增加的間隔重試,嘗試之間的最大間隙為8小時。 了解HubSpot開發者文件中的特定錯誤代碼例外。

開發者Webhooks文檔中了解更多關於Webhooks的資訊。 如果您對使用HubSpot網路鉤的實施有疑問,請聯絡HubSpot開發人員論壇

 在工作流程中設定webhook

  • 在 HubSpot 帳戶中,進入「自動化」>「工作流程」。
  • 按一下工作流  的名稱
  • 按一下+圖示 以新增操作。
  • 在右側面板中,選擇傳送webhook
  • 按一下[方法]下拉式選單,然後選擇發佈取得。 
  • 輸入webhook網址。Webhook URL僅限於安全協定,且必須以HTTPS開頭。 若要索取特定資訊,您可以將查詢參數(如? queryparameter = abc )新增至Webhook網址 如果沒有新增查詢參數,則會發送通用文章或GET請求。  
  • 設定驗證類型以驗證至Webhook的請求:
    • 要在webhook標題中使用請求簽名:
      • 按一下驗證類型下拉選單。 然後,選擇在標題中包含請求簽名
      • 然後輸入您的HubSpot應用程式ID。 了解如何 驗證申請簽名
    • 您也可以使用API金鑰進行驗證。 使用API金鑰進行驗證時,使用的API金鑰名稱API金鑰位置取決於Webhook的配置方式。 出於安全原因, API金鑰不會在任何測試要求中顯示。 要使用API金鑰:
      • 按一下驗證類型下拉選單。 然後選擇API金鑰。 
      • 輸入您的API金鑰名稱
      • 按一下API關鍵位置下拉式選單。 然後,選擇 查詢參數要求標題。 進一步瞭解如何在HubSpot中使用API金鑰
  • 如果要設定POST請求,您可以選擇包含CRM記錄中的所有屬性,或僅傳送特定屬性:
    • 若要包含所有屬性,請在「自訂申請正文」部分下選擇包含所有屬性。  
    • 若要僅包含特定屬性: 
      • 「自訂請求正文」部分下,選擇選擇特定屬性
      • 按一下選擇屬性下拉選單。 然後,按一下此工作流程中的[object] ,然後選擇一個屬性
      • 若要在webhook中更改屬性名稱,請編輯屬性名稱文字欄位。 這只會更新POST申請中的屬性名稱,不會更新HubSpot中的屬性名稱或內部名稱。  
      • 若要新增其他屬性,請按一下新增屬性
      • 若要移除屬性,請按一下刪除 垃圾桶圖示。 
           


  • 如果要設定GET請求,可以使用屬性作為查詢參數: 
    • 在「查詢參數」部分下,按一下選擇屬性下拉選單。 然後,按一下此工作流程中的[object] ,然後選擇一個屬性
    • 若要在查詢參數中更改屬性名稱,請編輯屬性名稱文字欄位。 這只會更新GET申請中的屬性名稱,不會更新HubSpot中的屬性名稱或內部名稱。  
    • 若要新增其他屬性,請按一下新增查詢參數
    • 若要移除屬性,請按一下刪除 垃圾桶圖示。     
  • 按一下儲存。 



自定義您的帖子要求

如果要設定POST請求,您可以選擇包含CRM記錄中的所有屬性,或僅傳送特定屬性:

  • 若要包含所有屬性,請在「自訂申請正文」部分下選擇包含所有屬性。  
  • 若要僅包含特定屬性: 
    • 「自訂請求正文」部分下,選擇選擇特定屬性
    • 按一下選擇屬性下拉選單。 然後,按一下此工作流程中的[object] ,然後選擇一個屬性
    • 若要在webhook中更改屬性名稱,請編輯屬性名稱文字欄位。 這只會更新POST申請中的屬性名稱,不會更新HubSpot中的屬性名稱或內部名稱。  
    • 若要新增其他屬性,請按一下新增屬性
    • 若要移除屬性,請按一下刪除 垃圾桶圖示。 
         


自訂您的GET請求

如果要設定GET請求,可以使用屬性作為查詢參數來檢索特定資料: 

  • 在「查詢參數」部分下,按一下選擇屬性下拉選單。 然後,按一下此工作流程中的[object] ,然後選擇一個屬性
  • 若要在查詢參數中更改屬性名稱,請編輯屬性名稱文字欄位。 這只會更新GET申請中的屬性名稱,不會更新HubSpot中的屬性名稱或內部名稱。  
  • 若要新增其他屬性,請按一下新增查詢參數
  • 若要移除屬性,請按一下刪除 垃圾桶圖示。     
  • 按一下儲存。 

在HubSpot中測試您的webhook

設定文章取得webhook時,您可以執行測試以查看webhook回應。 在測試期間,隨著數據發送到第三方並從第三方檢索, HubSpot中的現有記錄將不會受到影響。 如果你使用API金鑰進行驗證, API金鑰將不會顯示在任何測試要求中。

測試Webhook後,您可以選擇輸出哪些欄位用作工作流程中之後的輸入。 僅選擇每個回應中可用的輸出。 如果輸出在後面的動作中使用,但在回應中無法使用,則動作將失敗。   

  • 在側邊面板中,按一下測試操作以擴展部分。 
  • 按一下[物件]下拉式選單,然後選擇要測試的記錄
  • 按一下測試。 
  • 若要查看網絡鉤的詳細資訊,請選擇回覆申請標籤。 在每個標籤上,您可以按一下開啟全部以擴展所有區域,或按一下全部折縮以收起所有區域。 
    • 在「回覆」標籤中,按一下標題:正文:以展開每個部分。 
    • 在「請求」標籤中,按一下httpHeaders:以展開該部分。

在外部測試您的webhook

使用webhook操作建立工作流程後,您可以使用擬Webhook網址執行快速測試:

  • 在瀏覽器中,瀏覽器前往https://webhook.site複製專屬網址
  • Webhook操作中的Webhook URL字段中,貼上URL。

如果觸發包含POST請求的webhook動作, JSON回應正文將發送到webhook ,其中包含有關聯絡人的所有資訊,包括表單提交、清單會籍和所有聯絡人屬性值。 接收系統可以解析JSON資料,並將其用於自己的應用程式。

如果觸發具有GET請求的webhook動作,則會傳送通用GET請求,除非已套用其他查詢參數。   

請注意:歷史旅居價值只會在基於聯絡的工作流程中傳回。 在所有其他工作流程類型中使用的Webhook只會傳回最新的值。

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

如果在「驗證」區段中為觸發webhook操作選擇了「請求簽名」, HubSpot會在webhook中填充X-HubSpot-Signature標題,其中包含應用程式應用程式祕密聯接的SHA-256哈希、HTTP方法、URI和未解析正文。 詳情請參閱開發人員文件。

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

Was this article helpful?
This form is used for documentation feedback only. Learn how to get help with HubSpot.