跳转到主内容
Procore

配置公司 Webhook

目标

配置 Webhook 功能,以在公司级别的一个或多个 Procore API 资源发生变化时接收通知。

背景

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

Webhook 功能的好处包括:

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

需要考虑的事项

  • 所需用户权限:
    • 公司级别管理员工具的“管理员”级别权限。
  • 开发人员信息:

步骤

  1. 导航到公司级别管理员工具。
  2. 在“公司设置”下,点击 Webhook
    这将打开“Webhook”配置页面,其中包括用于输入 Web 服务器 URL 的通知端点字段和用于选择希望接收通知的资源和相应更改操作的资源网格


    company_webhooks_config.png

 

  1. 请执行以下操作:
  2. 资源网格中,对希望接收相应通知的任何资源,勾选“创建”、“更新”和“删除”框。请注意,选择操作立即生效,无需“提交”更改。
    注意请记住,配置 Webhook 时只需确定要接收通知的资源/操作。只有当资源发生实际更改时才会收到通知。

Webhook 交付

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

 

deliveries.png

 

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

 

deliveries-expand-project.png

 

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

more-deliveries.png

监控和警报

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

另请参阅

  • 有关在项目级别配置 Webhook 的信息,请参阅配置项目 Webhook
  • 有关其他信息,请参阅测试版邀请中包含的材料。