跳转到主内容
Procore

配置项目 Webhook

  1. 最后更新
  2. 另存为PDF

目标

配置 Webhook 功能以在项目中的一个或多个 Procore API 资源发生变更时接收通知。

背景

Webhook 是一种自动消息或 HTTP 请求，当特定事件发生时，它从一个应用程序实时发送到另一个应用程序，可实现实时数据更新，而无需不断轮询或手动请求。Webhook 可自动执行在应用程序之间传输数据的过程，从而使一个应用程序无需不断检查另一个应用程序的更新。

在 Procore 中，Webhook 功能允许公司和项目管理员启用第三方开发人员和集成商，以便在发生创建、更新或删除操作时订阅一个或多个Procore API资源的事件通知。例如，每当在 Procore 中创建新的 RFI 时，第三方RFI 集成可能希望收到通知。

Webhook 功能的好处包括：

  • 实现 Procore 与第三方应用程序和服务之间的即时通信。Webhook 不会等待应用程序请求信息，而是在事件发生后立即从 Procore 推送数据。这可确保系统始终保持最新状态。

  • 每当发生特定事件时，通过在第三方应用程序中触发操作来实现工作流的自动化。

  • 通过消除对持续轮询的需要，Webhook 可以降低服务器负载并节省带宽。这样做可以更有效地使用资源。

  • 通过轮询减少API请求数量可以节省大量成本，特别是对于处理大量数据的应用程序而言。

需要考虑的事项

  • 管理员信息:
    • 项目管理员工具的“管理员”权限。
  • 开发人员信息：

创建新挂钩

  1. 导航到项目级别管理员工具。

  2. 在"项目设置"下，点击Webhook 。

  3. 在“Webhook”页面上，单击“ 创建挂钩”。

这将打开一个新的挂钩配置页面，其中包括许多用于配置挂钩的字段和控件。

  1. 端点配置:

  • 端点URL - 输入第三方Web 服务器上端点的URL ，该服务器将在触发 Webhook 时处理来自 Procore 的POST请求。
  • 授权标头（可选） - 输入你想要放在 Procore 发送的POST请求标头中的授权令牌。此字段可用于定义你想要的任何授权标头信息，但它最常用于指定第三方服务器的授权凭据。例如，此字段的有效条目可能是"基本 c3a24b8208ac5199d083d54a1234e94b8864"。
  • 有效负载格式- 选择要发送到第三方服务的 REST API有效负载版本。你需要与第三方开发人员合作，以了解首选哪种负载格式。请注意，创建挂钩后，负载版本将无法更改。如果需要更改负载版本，则需要删除并重新创建挂钩。有关其他信息，请参阅 Webhook 有效负载格式
  1. 选择要发送的事件:

  1. 查看选定事件:

你可以查看已选择的通知事件，并在需要时删除一些事件。

查看 Webhook 事件

创建和配置挂钩后，你可以查看 Procore 已发送到第三方服务的事件的状态。
概述部分提供了 hook 的高级摘要，包括 hook 状态和其他相关信息。

"事件"部分显示所选挂钩的事件历史记录。事件历史记录可滚动维护 28 天。

每个事件都由其资源名称、资源 ID、事件类型、事件状态和协调世界时时间戳标识。

事件状态的可能值如下:

  • 已交付 - 事件已成功传递到第三方服务。

  • 已放弃 - 事件已被放弃。将不会进一步尝试交付。

  • 失败 - 事件交付失败。

  • 已排队 - 事件已排队等待传输到第三方服务。

  • 正在重试 - 正在再次尝试事件的递送。

你可以使用事件列表执行各种操作:

  • 按资源 ID 搜索有关特定资源的事件。

  • 使用资源名称下拉列表以仅显示所选资源的事件。

  • 使用事件状态下拉菜单仅显示具有所选事件状态的事件。

  • 使用筛选器按钮在事件列表上创建自定义筛选器。

  • 点击列表中的单个事件以查看详细信息。

另请参阅