跳转到主内容
Procore

配置项目 Webhook

 

目标

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

背景

Webhook 功能使第三方开发商和集成商能够指定一个或多个 Procore API 资源,从而在发生创建、更新或删除操作时收到通知。用于配置 Webhook 功能的用户界面可通过 Procore 中的项目管理员工具访问。

Webhook 功能的好处包括:

  • 无需在第三方集成中使用轮询逻辑/代码来确定资源变更
  • 通过用异步更新代替轮询来提高性能
  • 提高效率,因为只需在资源变化时运行代码
  • 降低超过 Procore API 速率上限的风险

需要考虑的事项

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

步骤

  1. 导航到项目的管理员工具。
    这将显示“一般项目信息”页面。
  2. 在侧边栏中的“项目设置”菜单下,点击 Webhook

    project_settings_webhooks.png

    这将打开“Webhook”配置页面,其中包括用于输入 Web 服务器 URL 的通知端点字段,以及用于选择你想要接收通知的资源和相应更改操作的资源网格

    project_webhooks_config.png

 

  1. 通知端点字段中,输入 Web 服务器上端点的 URL,该端点将处理来自 Procore 的 POST 请求。
  2. (可选)在授权标头字段中,输入你希望放置在来自 Procore 的 POST 请求标头中的授权令牌。尽管此字段可用于定义你想要的任何授权标头信息,但它最常用于使用以下语法指定授权凭证:<type> <credential>,其中 <type> 是授权类型('Basic'、'Token'、'Bearer' 等),<credential> 是令牌值。例如,此字段的有效条目为 Basic c3a24b8208ac5199d083d54a1234e94b8864。
  3. 点击保存端点。如果你在通知端点字段中输入了有效且格式正确的地址,将看到屏幕顶部出现一个绿色横幅,提示操作成功。如果你输入的 URL 有任何问题,则会显示一个警告横幅,描述可能的问题。
  4. 资源网格中,为你想要接收相应通知的任何资源选择“创建”、“更新”和“删除”操作。请注意,操作选择会在你做出选择后立即生效,无需“提交”更改。

    注意:请记住,在配置 Webhook 时,你只是确定要接收通知的资源/操作。只有当资源发生实际更改时,你才会收到通知。

Webhook 交付

公司 Webhook 页面底部提供了通知端点的 Webhook 交付运行日志。可在交付部分快速查看 Procore 已发送(或已尝试发送)到通知服务器的事件的状态。默认情况下,成功和失败的交付都包含在显示结果中。你可以使用“仅显示失败”复选框来筛选显示结果,从而仅显示失败交付。

 

deliveries.png

 

最近的交付出现在“交付”部分顶部。点击交付条目会显示有关“请求有效负载”、“答复标题”和“答复正文”的详细信息。

 

deliveries-expand-project.png

交付日志分页显示,一次最多显示 25 个交付。点击“更多交付”会显示下一组 25 个交付。

more-deliveries.png

监控和警报

我们强烈建议你对通知端点服务器进行适当的监控,确保识别任何停机或其他与性能相关的问题,并通过可靠的警报系统及时通知你。许多商业监控系统都可以用于此目的,包括 DatadogNew Relic等。这些服务提供强大的监控功能,让你可以通过可配置图表、图形和实时分析轻松地可视化系统的运行状况。这些服务还提供内置警报,以便在出现问题时及时通知你。

另请参阅