Contact Support

创建 Webhooks

更新

Webhooks 提供了一种强大的方式，从您的 Awardco 平台 获取实时更新，实现与其他应用程序的无缝集成。与需要您不断检查新信息的传统 API 不同，webhooks 会在 Awardco 中发生相关事件时，自动将数据发送到您指定的位置。这确保您始终拥有最新的信息，无任何延迟。

目前，我们的 webhooks 功能专注于 Recognition 事件，这意味着您可以即时接收 Awardco 中发生的认可数据。该数据包括赠予者、接收者、积分数量、认可备注和项目名称等详细信息。本文将引导您如何创建、配置和管理 webhooks，以便将您的 Awardco 平台中的认可数据同步到您选择的端点。

 

  1. Webhook 使用场景 
  2. 前往 Webhook 创建页面
  3. 创建 Webhook
  4. 管理 Webhooks
  5. 常见问题解答

 

Webhook 使用场景 

Webhooks 允许您的组织在平台外的社交动态（例如公司内网）上展示实时认可更新。

与通过调用动态 API 连接不同，webhooks 的过程是即时的。只要在您的 Awardco 平台 中提交认可，webhook 就会被触发，认可数据会立即发送到您指定的端点，从而实现外部动态的即时更新。

 

前往 Webhook 创建页面

开始创建和管理 webhooks 的步骤：

  1. 登录您的认可平台。
  2. 在首页，选择左侧导航菜单底部的 管理员 按钮。
  3. 选择“平台”，然后依次选择“集成”，接着从左侧导航菜单选择“Webhooks”。

在 Webhooks 页面，您将看到任何现有 webhook 的列表。要创建新的 webhook，请点击 创建 Webhook 按钮。

 

 

 

创建 Webhook

点击“创建 Webhook”后，会弹出一个模态窗口，您可以在其中配置新的 webhook。以下是各字段的说明：

  • 名称：为您的 webhook 命名一个描述性名称。这将帮助您以后识别，尤其是在有多个 webhook 的情况下。
  • 触发事件：此下拉菜单目前仅有一个选项：Recognition Complete（认可完成）。这意味着每当 Awardco 中的认可成功发送时，您的 webhook 就会激活。我们未来会根据客户需求考虑添加更多触发事件类型。
  • 端点 URL：这是接收认可数据的 URL。您需自行提供此 URL。这是 webhook 通信的“位置”。
  • 密钥：这是一个自动生成的安全措施。当 Awardco 发送 webhook 请求时，您将使用此密钥创建签名。该签名会与 Awardco 发送的签名进行比较。如果匹配，则验证数据确实来自 Awardco，而非恶意第三方。有关如何生成此签名的更多技术细节，请参阅我们 API 文档中的“Webhook 验证”部分。
  • 错误接收邮箱：如果 webhook 发送数据时出现任何问题，错误日志将发送至此处列出的邮箱地址。您可以通过逗号分隔添加多个邮箱地址。
  • 状态：切换为 激活，以便在触发事件发生时传递事件数据。设置为 非激活 将暂停 webhook。
  • 运行测试：点击此按钮，向您指定的端点 URL 发送模拟认可数据。这可帮助您在 webhook 正式运行前验证设置是否正确。测试后请记得删除平台外动态中出现的任何测试认可。

 

 

 

管理 Webhooks

创建 webhook 后，您可以在主 Webhooks 页面进行管理。在每个 webhook 旁边，有一个三点菜单，包含以下选项：

  • 查看详情：显示 webhook 的一般信息，包括复制密钥的功能。
  • 编辑：返回 webhook 创建模态窗口，您可以修改 webhook 的任何设置。
  • 运行测试：与创建时的“运行测试”按钮类似，向您的端点 URL 发送模拟数据，确保 webhook 正常工作。
  • 设置为非激活：暂停 webhook，防止其被触发和发送数据。
  • 设置为激活：（仅在 webhook 非激活时显示）重新激活 webhook，使其可以再次被触发。
  • 删除：永久删除该 webhook。

 

 

 

常见问题解答

  • 问：webhooks 和 APIs 有什么区别？
    • 答：API 通常需要您发起请求来拉取数据。而 webhooks 是“事件驱动”的，意味着一旦发生特定事件（如认可发送），它们会自动将数据推送到您指定的端点。这使得 webhooks 非常适合实时更新。
  • 问：我能获得除“Recognition Complete”以外的事件的 webhooks 吗？
    • 答：目前，“Recognition Complete”是唯一可用的触发事件。我们正在考虑未来添加更多触发事件类型。如果您有具体的使用场景，请联系您的 Awardco 客户代表。
  • 问：在哪里可以找到更详细的 webhook 技术文档？
    • 答：我们的 API 文档中有专门的 webhook 部分，提供更多技术细节，包括如何使用密钥生成签名以进行 webhook 验证。该页面目前处于测试阶段，可直接访问：https://api.awardco.com/api/webhooks




 

If you have any questions, please contact Awardco Admin Support.

关于