與HubSpot工作流一起使用Webhook
上次更新時間: 三月 31, 2023
在工作流程中使用webhook來傳送或檢索HubSpot與其他外部工具之間的資訊。 Webhook有多種用途, Webhook的常見用例包括:
當HubSpot聯繫人填寫您網站上的特定表單時,將數據發佈到另一個系統(如CRM )。
將交易數據發送到外部裝運處理系統以建立採購訂單。
從外部系統向公司的聊天流發送聊天提醒,通知員工發生了重要事情。
- 從其他系統檢索資料以更新您的HubSpot記錄。
您可以使用工作流程發送POST和GET請求。 HubSpot將Webhook流量與其他工作流程分開調節。 這是為了簡化工作流程和Webhook效能。 當Webhook緩慢或超時時時,工作流程動作可能需要比預期執行時間更長的時間。
請注意: HubSpot將重試失敗的Webhook最多三天,失敗後一分鐘開始。 隨後的故障將以增加的間隔重新嘗試,嘗試之間的最大間隔為8小時。 了解HubSpot開發人員文件中的特定錯誤代碼例外情況。
在開發人員webhooks文檔中了解有關webhooks的更多信息。 如果您對使用HubSpot實現Webhooks的具體問題有疑問,請聯繫HubSpot開發人員論壇。
在工作流中設定Webhook
- 在 HubSpot 帳戶中,進入「自動化」>「工作流程」。
- 按一下工作流程的名稱。
- 按一下+圖示 以新增操作。
- 在右側面板中,選擇傳送網頁連結。
- 按一下「方法」下拉菜單,然後選擇POST或GET。
- 輸入webhook URL。 Webhook URL僅限於安全協議,並且必須以HTTPS開頭。 若要請求特定資訊,您可以將查詢參數(例如
? queryparameter = abc
)新增至Webhook URL。 如果沒有新增查詢參數,將發送一般的POST或GET請求。 - 設定驗證類型以驗證對Webhook的請求:
- 若要在Webhook標題中使用請求簽名,請按照以下步驟操作:
- 按一下驗證類型下拉式選單。 然後,在標頭中選擇包含請求簽名。
- 然後,輸入您的HubSpot App ID。 了解如何 驗證請求簽名。
- 若要在Webhook標題中使用請求簽名,請按照以下步驟操作:
-
- 您也可以使用API金鑰或HubSpot私人應用程式進行驗證。
請注意:自2022年11月30日起, HubSpot API金鑰已過時,不再受支援。 您仍然可以在HubSpot工作流程中使用外部API金鑰進行驗證。
-
-
- 當使用API金鑰進行驗證時,所使用的API金鑰名稱和API金鑰位置取決於Webhook的配置方式。 基於安全原因, API金鑰不會顯示在任何測試請求中。 若要使用API金鑰:
- 按一下驗證類型下拉式選單。 然後選擇API Key。
- 當使用API金鑰進行驗證時,所使用的API金鑰名稱和API金鑰位置取決於Webhook的配置方式。 基於安全原因, API金鑰不會顯示在任何測試請求中。 若要使用API金鑰:
-
-
-
-
- 輸入您的API金鑰名稱。
- 按一下API金鑰位置下拉式選單。 然後,選擇 Query parameters或Request header。 進一步了解如何在HubSpot中使用API金鑰。
- 如果您向我們的HubSpot API提出要求:
- 按一下API金鑰下拉式選單,然後選擇一個機密。 Secret值的格式必須為Bearer [YOUR_TOKEN]。
- 將API金鑰名稱的值設定為授權。
- 將API金鑰位置的值設置為Request Header。
-
-
- 如果您正在設置POST請求,您可以選擇包含CRM記錄中的所有屬性或僅傳送特定屬性:
- 若要包含所有屬性,請在自訂請求正文部分下,選擇包含所有屬性。
- 若要只包含特定的屬性:
- 在自訂請求正文部分下,選擇選擇特定屬性。
- 按一下選擇房源下拉式選單。 然後,按一下此工作流程中的[object] ,然後選擇一個屬性。
- 若要在webhook中更改房源名稱,請編輯房源名稱文字欄位。 這只會更新POST請求中的屬性名稱,不會更新HubSpot中的屬性名稱或內部名稱。
- 若要新增其他屬性,請按一下「新增屬性」。
- 若要移除旅居,請按一下「刪除 垃圾桶」圖示。
- 如果您正在設定GET請求,您可以使用屬性作為查詢參數:
- 在「查詢參數」區段下,按一下「選擇屬性」下拉式選單。 然後,按一下此工作流程中的[object] ,然後選擇一個屬性。
- 若要更改查詢參數中的房源名稱,請編輯房源名稱文字欄位。 這只會更新GET請求中的屬性名稱,它不會更新HubSpot中的屬性名稱或內部名稱。
-
- 若要新增其他屬性,請按一下「新增查詢參數」。
- 若要移除旅居,請按一下「刪除 垃圾桶」圖示。
- 按一下儲存。
自定義您的POST要求
如果您正在設置POST請求,您可以選擇包含CRM記錄中的所有屬性或僅傳送特定屬性:
- 若要包含所有屬性,請在自訂請求正文部分下,選擇包含所有屬性。
- 若要只包含特定的屬性:
- 在請求正文部分下,選擇自訂請求正文。
- 輸入Key和Value。
- 若要在webhook中更改房源的名稱,請編輯Key文字欄位。 這只會更新POST請求中的屬性名稱,不會更新HubSpot中的屬性名稱或內部名稱。
- 若要新增其他屬性,請按一下「新增屬性」。
- 若要移除房源,請按一下刪除 垃圾箱圖示。
自訂您的GET請求
如果您正在設置GET請求,您可以使用屬性作為查詢參數來檢索特定數據:
- 在「查詢參數」部分下,輸入「密鑰」,然後選擇一個屬性。
- 若要更改查詢參數中的房源名稱,請編輯房源名稱文字欄位。 這只會更新GET請求中的屬性名稱,它不會更新HubSpot中的屬性名稱或內部名稱。
- 若要新增其他屬性,請按一下「新增屬性」。
- 若要移除旅居,請按一下「刪除 垃圾桶」圖示。
- 從下拉式選單中選擇驗證類型。
- 按一下儲存。

在HubSpot中測試您的Webhook
設定您的文章或取得webhook時,您可以執行測試以檢視webhook回應。 在測試期間,當資料被傳送至第三方並從第三方檢索時, HubSpot中的現有記錄不會受到影響。 如果您使用API金鑰進行驗證,則API金鑰不會顯示在任何測試請求中。
測試Webhook後,您可以選擇要輸出的欄位,以便稍後在工作流程中用作輸入。 僅選擇每個回應中可用的輸出。 如果輸出在以後的操作中使用,但在響應中不可用,則操作將失敗。
- 在側邊面板中,按一下「測試動作」以展開部分。
- 按一下物件下拉式選單,然後選擇要測試的記錄 。
- 按一下「測試」。
- 若要檢查網頁連結的詳細資訊,請選擇「回應」或「申請」分頁。 在每個標籤上,您可以按一下「全部開啟」以展開所有區段,或按一下「全部折疊」以折疊所有區段。
- 在「回應」標籤中,按一下標題:或正文:以展開每個部分。
- 在「請求」標籤中,按一下httpHeaders:以展開部分。
在外部測試您的Webhook
使用webhook動作建立工作流程後,您可以使用虛擬webhook URL執行快速測試:
- 在瀏覽器中,前往https://webhook.site並複製唯一網址。
- 在Webhook操作中的Webhook URL字段中,貼上網址。
- 開啟工作流程後,您可以手動註冊測試聯絡人。
如果觸發帶有POST請求的Webhook動作,則會將JSON回應正文發送到Webhook ,其中包含有關聯繫人的所有信息,包括表單提交,列表會員資格和所有聯繫人屬性值。 然後,接收系統可以解析JSON數據,並將其用於自己的應用程序。
如果觸發帶有GET請求的webhook動作,則將發送一般的GET請求,除非已應用額外的查詢參數。
請注意:歷史屬性值只會在基於聯絡人的工作流程中傳回。 在所有其他工作流程類型中使用的Webhook只會傳回最新的值。
驗證工作流Webhook中的請求簽名
如果您在「觸發Webhook動作」的身份驗證部分中選擇了「請求簽名」, HubSpot將使用X-HubSpot-Signature標頭填充Webhook ,其中包含應用程序的app-secret連接的SHA-256哈希, HTTP方法, URI和未解析正文。 請參閱開發人員文件,了解更多相關資訊。
若要驗證透過您的URL收到的請求是否來自HubSpot :
- 擁有一個開發者帳戶。 如果你沒有,請註冊一個開發人員帳戶。
- 擁有應用程式。如果您沒有應用程式,請了解如何建立應用程式。
- 檢查簽名的哈希值。
相關內容
-
建立工作流程
建立工作流程來自動化您的業務流程,並使您的團隊更有效率。 設定註冊標準以自動註冊記錄,並對您的聯絡人、公司、交易、報價和工單採取行動。 您也可以對相關記錄採取行動,例如更新已註冊聯絡人的相關公司。 ...
知識庫 -
選擇工作流程操作
建立工作流程並設定註冊觸發器後,選擇要新增到工作流程的操作。操作是工作流將對已註冊的記錄執行的函數。 例如,您可以新增傳送電子郵件、建立新記錄、管理聯絡人的訂閱等操作。您也可以使用已連結應用程式中的工作流程操作。
知識庫 -
設定工作流註冊觸發器
將工作流程註冊觸發器設定為在工作流程符合特定條件時自動註冊記錄。 根據工作流程的類型,將提供不同的註冊觸發器。 若要觀看此流程的概覽,請觀看以下影片: , 。 查看完整的HubSpot Academy課...
知識庫