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

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

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

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

• 從外部系統傳送即時通訊提醒至貴公司的即時通訊串流，通知員工已發生重要事件。

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

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

請注意： HubSpot將在失敗後一分鐘開始，最多三天內重試失敗的Webhook。 隨後的失敗將以增加的間隔重試，嘗試之間的最大間隙為8小時。 瞭解HubSpot開發人員文件中的特定錯誤代碼例外情況。

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

在工作流程中設定Webhook

• 在你的 HubSpot 帳戶中，瀏覽「自動化」>「工作流程」。
• 按一下工作流程的名稱 。
• 按一下「+」圖示以新增動作。
• 在右側面板中，選取傳送Webhook。
• 點擊「方法」下拉式選單，然後選擇「發佈」或「取得」。 
• 輸入Webhook網址。 Webhook網址僅限於安全通訊協定，且必須以HTTPS開頭。 若要請求特定資訊，您可以將查詢參數（例如？ queryparameter = abc ）新增至Webhook URL。 如果尚未新增查詢參數，系統會傳送一般POST或GET要求。 
• 設定驗證類型，以驗證Webhook的請求：
  • 若要在Webhook標頭中使用請求簽名，請按照以下步驟操作：
    • 點擊驗證類型下拉式選單。 然後，選取在標題中包含請求簽名。
    • 然後，輸入您的HubSpot應用程式ID。 了解如何驗證請求簽名。

• • 您也可以使用API金鑰或透過開發人員帳戶建立的公開應用程式進行驗證。

請注意：截至2022年11月30日， HubSpot API金鑰已被棄用，不再受支援。 您仍然可以在HubSpot工作流程中使用外部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。
• 如果要設定POST請求，你可以選擇包含CRM記錄中的所有旅居，或只傳送特定旅居：
  • 若要包含所有屬性，請在「自訂要求內文」區段中選取包含所有屬性。 
  • 若要僅包含特定屬性： 
    
    • 在「自訂請求內文」部分下，選取「選擇特定屬性」。
    • 點擊「選擇旅居」下拉式選單。 然後，點擊此工作流程中的[object]並選擇一個屬性。
    • 若要在Webhook中變更屬性名稱，請編輯「屬性名稱」文字欄位。 這只會更新POST請求中的旅居名稱，不會更新HubSpot中的旅居名稱或內部名稱。 
    • 若要新增其他旅居，請按一下「新增旅居」。
    • 若要移除旅居，請按一下「刪除 垃圾桶」圖示。 
       

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

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

自訂你的文章請求

如果要設定POST請求，你可以選擇包含CRM記錄中的所有旅居，或只傳送特定旅居：

• 若要包含所有屬性，請在「自訂要求內文」區段中選取包含所有屬性。 
• 若要僅包含特定屬性： 
  
  • 在「請求內文」部分下方，選取「自訂請求內文」。
  • 輸入Key和Value。
  • 若要在Webhook中變更屬性名稱，請編輯Key文字欄位。 這只會更新POST請求中的旅居名稱，不會更新HubSpot中的旅居名稱或內部名稱。 
  • 若要新增其他旅居，請按一下「新增旅居」。
  • 若要移除旅居，請按一下刪除 垃圾桶圖示。 
    
    

自訂GET預約

如果要設定GET要求，可以使用屬性作為查詢參數來擷取特定資料： 

• 在「查詢參數」區段中，輸入金鑰，然後選擇屬性。
• 若要在查詢參數中變更屬性名稱，請編輯「屬性名稱」文字欄位。 這只會更新GET要求中的屬性名稱，不會更新HubSpot中的屬性名稱或內部名稱。 
• 若要新增其他旅居，請按一下「新增旅居」。
• 若要移除旅居，請按一下「刪除 垃圾桶」圖示。 
• 從下拉式選單中選擇驗證類型。
• 按一下儲存。 
  
  

在HubSpot中測試Webhook

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

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

• 在側邊面板中，按一下「測試動作」以展開部分。 
• 按一下物件下拉式選單，然後選取要測試的記錄 。
• 按一下測試。 
• 若要檢查Webhook詳細資訊，請選取「回應」或「要求」索引標籤。 在每個標籤上，您可以按一下「全部開啟」展開所有區段，或按一下「全部折疊」折疊所有區段。 
  
  • 在「回應」索引標籤中，按一下標題：或內文：以展開每個區段。 
  • 在「請求」索引標籤中，按一下httpHeaders:以展開區段。
    
    

從外部測試Webhook

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

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

• 開啟工作流程後，您可以手動註冊測試客服案件。 

如果觸發具有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中的資料：

• 在你的 HubSpot 帳戶中，瀏覽「自動化」>「工作流程」。
• 按一下工作流程的名稱。
• 按一下+加號圖示以新增動作。
• 在左側面板中，選擇使用資料面板的操作。
• 在資料面板的註冊屬性下，您可以從連接的Webhook中選擇其中一個屬性。