如何在 HubSpot 的“基于联系人的工作流”中触发 Webhook

在基于联系人的工作流中使用 Webhook，可在 HubSpot 与您的外部工具之间发送或获取数据。这使您能够实现跨平台的流程自动化。您可以使用 POST Webhook 从 HubSpot 发送数据，并使用 GET Webhook 从外部工具获取数据。

在设置 POST 或 GET Webhook 时，可通过速率限制控制 Webhook 的执行速度，并在 HubSpot 内或使用外部工具手动测试您的 Webhook 配置。 
您还可以了解如何验证来自 HubSpot 的请求、如何使用 webhook 自动启动工作流，以及如何在其他工作流操作中使用 webhook 响应数据。

请参阅开发者 webhook 文档，了解更多关于 webhook 的信息。如果您对在 HubSpot 中具体实现 webhook 有疑问，请在HubSpot 开发者论坛中提问。

Webhook 典型用例

Webhook 的常见用例包括：

• 当联系人填写您网站上的特定表单时，将 HubSpot 联系人数据发布到另一个系统（例如 CRM）中。

• 将交易数据发送至外部发货处理系统以创建采购订单。

• 从其他系统检索数据以更新您的 HubSpot 记录。

您可以通过工作流发送 POST 和 GET 请求。HubSpot 将 Webhook 流量与其他工作流流程分开管理。此举旨在优化工作流和 Webhook 的性能。当 Webhook 响应缓慢或超时，工作流操作的执行时间可能会比预期更长。

使用 POST Webhook 从 HubSpot 发送数据

1. 在你的 HubSpot 帐户中，单击更多，然后导航到自动化 > 工作流。如果你的帐户中未显示更多，请直接导航到自动化 > 工作流。
2. 要编辑现有工作流，请点击工作流名称。或者，创建一个新工作流。
3. 在工作流编辑器中，点击“+”号图标添加操作。
4. 在左侧面板的“数据操作”部分，选择“发送 Webhook”。
    

5. 点击“方法”下拉菜单，选择“POST”。
6. 输入Webhook URL。
   • Webhook URL 必须使用安全协议，且必须以 HTTPS 开头。
   • 若要请求特定信息，您可以在Webhook URL中添加查询参数，例如?queryparameter=abc 。
   • 如果未添加任何查询参数，系统将发送一个通用的 POST 或 GET 请求。
7. 设置身份验证类型，以对发往 Webhook 的请求进行身份验证。您可以在 Webhook 头中使用请求签名，或使用 API 密钥：
   • 要在 Webhook 头中使用请求签名：
     • 点击“身份验证类型”下拉菜单，然后选择 “在标头中包含请求签名”。
     • 接着，输入您的HubSpot 应用 ID。了解如何验证请求签名。
   • 若要使用 API 密钥或通过开发者账户创建的公共应用进行身份验证：
     • 使用 API 密钥进行身份验证时，所使用的API 密钥名称和 API 密钥位置取决于 webhook 的配置方式。出于安全考虑，API 密钥不会显示在任何测试请求中。要使用 API 密钥：
       • 点击“身份验证类型”下拉菜单，然后选择 “API密钥”。
       • 输入您的API 密钥名称。
       • 点击“API 密钥位置”下拉菜单，然后选择“查询参数”或“请求头”。了解有关在 HubSpot 中使用API 密钥的更多信息。
     • 如果您正在向 HubSpot API 发送请求：
       • 点击“API密钥”下拉菜单，然后选择一个密钥。密钥值必须采用“Bearer [YOUR_TOKEN]”的格式。
       • 将“API 密钥名称”的值设置为“Authorization”。
       • 将“API 密钥位置 ”的值设置为 “请求头”。
8. 若要包含所有属性，请选择“包含所有 [对象] 属性”。
9. 若要仅包含特定属性：
   • 请选择“自定义请求正文”。
   • 若要使用 HubSpot 属性自定义请求正文，请输入“键”并选择一个属性。要添加另一个属性，请点击“添加属性”。
   • 若要使用静态字段自定义请求正文，请输入“键”和“值”。要添加另一个属性，请点击“添加属性”。
   • 要删除属性或静态值，请点击垃圾桶图标。
10. 在顶部，点击“保存”。

请注意：若要选择多个输出项，响应应采用 JSON 对象的结构。

使用 GET Webhook 将数据导入 HubSpot

1. 在你的 HubSpot 帐户中，单击更多，然后导航到自动化 > 工作流。如果你的帐户中未显示更多，请直接导航到自动化 > 工作流。
2. 要编辑现有工作流，请点击该工作流的名称。或者，创建一个新工作流。
3. 在工作流编辑器中，点击“+”号图标以添加操作。
4. 在左侧面板的“数据操作”部分，选择“发送 Webhook”。
    

5. 点击“方法”下拉菜单，选择“GET”。
6. 输入Webhook URL。
   • Webhook URL 必须使用安全协议，且必须以 HTTPS 开头。
   • 若要请求特定信息，您可以在Webhook URL中添加查询参数，例如?queryparameter=abc 。
   • 如果未添加任何查询参数，系统将发送一个通用的 POST 或 GET 请求。
7. 设置身份验证类型，以对发往 Webhook 的请求进行身份验证。您可以在 Webhook 头中使用请求签名，或使用 API 密钥：
   • 要在 Webhook 头中使用请求签名：
     • 点击“身份验证类型”下拉菜单，然后选择 “在标头中包含请求签名”。
     • 接着，输入您的HubSpot 应用 ID。了解如何验证请求签名。
   • 若要使用 API 密钥或通过开发者账户创建的公共应用进行身份验证：
     • 使用 API 密钥进行身份验证时，所使用的API 密钥名称和 API 密钥位置取决于 webhook 的配置方式。出于安全考虑，API 密钥不会显示在任何测试请求中。要使用 API 密钥：
       • 点击“身份验证类型”下拉菜单，然后选择 “API密钥”。
       • 输入您的API 密钥名称。
       • 点击“API 密钥位置”下拉菜单，然后选择“查询参数”或“请求头”。了解有关在 HubSpot 中使用API 密钥的更多信息。
     • 如果您正在向 HubSpot API 发送请求：
       • 点击“API密钥”下拉菜单，然后选择一个密钥。密钥值必须采用Bearer [YOUR_TOKEN] 的格式。
       • 将“API 密钥名称”的值设置为“Authorization”。
       • 将“API 密钥位置 ”的值设置为 “请求头”。
8. 如果您正在配置 GET 请求，可以使用 HubSpot 属性，也可以将静态值作为查询参数添加： 

9. 要将 HubSpot 属性用作查询参数：
   • 在“查询参数”部分 ，输入“键”，然后选择一个属性。
   • 要添加另一个属性，请点击“添加属性”。
   • 要删除属性，请点击删除图标。
10. 要将静态值用作查询参数：
    • 在“查询参数”部分 ，输入“键”，然后输入一个值。
    • 要添加另一个属性，请单击“添加静态值”。
    • 要删除一个属性，请点击删除 图标。
11. 点击“保存”。

通过

速率限制

控制 Webhook 执行速度

设置速率限制以确定 Webhook 操作的执行速度。该速率限制也会影响工作流中后续的所有操作。

1. 在你的 HubSpot 帐户中，单击更多，然后导航到自动化 > 工作流。如果你的帐户中未显示更多，请直接导航到自动化 > 工作流。
2. 点击工作流的名称。
3. 在工作流编辑器中，点击“发送 Webhook”操作。
4. 在左侧面板中，点击“配置速率限制”以展开该部分。
5. 点击“启用速率限制”开关将其打开。默认情况下，此设置处于关闭状态。 
6. 设置速率限制： 
   • 操作执行次数：设置 每个时间段内的最大执行次数。 
   • 时间范围：设置速率限制的时间范围。您可以按秒、分钟或小时来设置该时间范围。 

在 HubSpot 中测试您的 Webhook 配置

在设置POST或GETWebhook 时，您可以执行测试以查看 Webhook 响应。测试期间，虽然数据会发送至第三方并从第三方检索，但 HubSpot 中的现有记录不会受到影响。如果您使用 API 密钥进行身份验证，该 API 密钥不会显示在任何测试请求中。

测试完 webhook 后，您可以选择要输出的字段，以便在后续工作流中作为输入使用。请仅选择在每个响应中都可用的输出字段。如果某个输出字段在后续操作中被使用，但在响应中不可用，则该操作将失败。

1. 在你的 HubSpot 帐户中，单击更多，然后导航到自动化 > 工作流。如果你的帐户中未显示更多，请直接导航到自动化 > 工作流。
2. 点击工作流的名称。
3. 在工作流编辑器中，点击“发送 Webhook”操作。
4. 在左侧面板中，点击“测试操作”以展开该部分。
5. 如果您正在测试 POST 请求，Webhook 测试的设置将根据您在 Webhook 操作中是否选择了“自定义请求正文”或“包含所有 [object] 属性”而有所不同。
   • 如果您选择了“自定义请求正文”，请输入测试所需的属性测试值。
   • 如果您选择了 “包含所有 [object] 属性”，请单击[object]下拉菜单，然后选择一个用于测试的记录。
6. 点击“测试”。
7. 要查看 Webhook 详细信息，请选择“响应”或“请求”选项卡。在每个选项卡上，您可以单击“展开全部”以展开所有部分，或单击“折叠全部”以折叠所有部分。
   • 在“响应”选项卡中，单击headers: 或 body: 以 展开每个部分。
   • 在“请求”选项卡中 ，点击“httpHeaders:”以 展开该部分。
     
     

使用外部工具测试 Webhook

在创建包含 Webhook 操作的工作流后，您可以使用一个模拟的 Webhook URL 进行快速测试：

1. 在浏览器中访问https://webhook.site，并复制该唯一 URL。
2. 在 Webhook 操作的“Webhook URL”字段中，粘贴该 URL。
3. 工作流启用后，您可以手动添加一个测试联系人。
4. 在外部测试 Webhook 时：
   • 如果触发了带有 POST 请求的 Webhook 操作，系统会向 Webhook 发送一个包含联系人所有信息的 JSON 响应正文，包括表单提交内容、列表成员身份以及所有联系人属性值。接收系统随后可以解析这些 JSON 数据，并将其用于自身的应用程序。
   • 如果触发了带有 GET 请求的 Webhook 操作，系统将发送一个通用 GET 请求，除非已应用额外的查询参数。

请注意：历史属性值仅会在基于联系人的工作流中返回。其他所有工作流类型中使用的 Webhook 仅会返回最新值。

验证 Webhook 请求

如果您在“触发 Webhook”操作的“身份验证”部分中选择了“请求签名”，HubSpot 将在 Webhook 中添加一个 X-HubSpot-Signature 标头，其值为您的应用程序的 app-secret、HTTP 方法、URI 以及未解析的请求正文的拼接结果，并采用 SHA-256 哈希算法进行计算。有关此内容的更多信息，请参阅开发者文档。

要验证您 URL 接收到的请求是否来自 HubSpot：

• 拥有开发者账户。如果您还没有，请注册一个开发者账户。
• 拥有一个应用。如果您还没有应用，请了解如何创建应用。
• 检查签名的哈希值。

使用 Webhook 触发工作流

Webhook 可用于触发工作流。当第三方应用中的数据发生变化时，这可能会触发一个工作流。了解有关通过 Webhook 触发工作流的更多信息。

在其他工作流操作中使用 webhook 响应数据

与您的账户连接的 webhook 中的数据可用于数据面板中的某些操作。

要使用已连接 webhook 中的数据：

1. 在你的 HubSpot 帐户中，单击更多，然后导航到自动化 > 工作流。如果你的帐户中未显示更多，请直接导航到自动化 > 工作流。
2. 点击您工作流的名称。
3. 点击“+”号图标添加操作。
4. 在左侧面板中，选择一个使用数据面板 的操作 。
5. 在数据面板的“操作数据”下，选择您的“发送 Webhook”操作。随后，您即可使用已连接 Webhook 的属性。
    

Webhook 失败时会发生什么

HubSpot 将在失败后一分钟开始，对失败的 Webhook 进行最多三天的重试。后续失败将以逐渐增加的间隔进行重试，每次重试之间的最大间隔为八小时。

工作流在收到 4XX 系列响应状态码后不会重试。但 429 速率限制错误除外；工作流在收到 429 响应后会自动重试，并会遵循（若存在）“Retry-After”标头。Retry-After 以毫秒为单位记录。有关具体错误代码的例外情况，请参阅HubSpot 的开发者文档。