配置公司 Webhook

目标

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

背景

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

Webhook 功能的好处包括：

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

需要考虑的事项

• 所需用户权限：
  • 公司级别管理员工具的“管理员”级别权限。
• 开发人员信息：
  • 有关开发应用程序或集成以正确支持 Webhook 的信息，请参阅开发人员门户上的 Webhooks 简介和使用 Webhooks API指南。

步骤

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

3. 请执行以下操作：

   1. 通知端点。输入 Web 服务器上端点的 URL，该端点将处理来自 Procore 的 POST 请求。

   2. 授权标头。（可选）输入你想要放在来自 Procore 的 POST 请求标头中的授权令牌。此字段可用于定义你想要的任何授权标头信息，但它最常用于使用以下句法指定授权凭据： ，其中 是授权类型（“Basic”、“Token”、“Bearer”等）， 是令牌值。例如，此字段的有效输入为 Basic c3a24b8208ac5199d083d54a1234e94b8864。

   3. 保存端点。点击此按钮可保存端点。如果在通知端点字段中输入了有效且格式正确的地址，则页面顶部会出现一个表示成功的绿色横幅。如果输入的 URL 有任何问题，则会显示一个描述存在的问题的警告横幅。

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

Webhook 交付

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

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

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

另请参阅

• 有关在项目级别配置 Webhook 的信息，请参阅配置项目 Webhook 。