聊天 API 平台的 Webhook

借助 Webhook,外部应用可以在平台中发生特定事件时接收实时通知。

如需使用 Webhook,您必须启用 Webhook 并生成令牌。通过为单个网络钩子网址使用两个单独的密钥,您可以增加一层额外的安全性。如果某个密钥泄露或因任何原因需要轮替,您可以更新和轮替密钥,而不会中断 Webhook 服务或危及数据安全。

启用 Webhook

如需启用 Webhook,请按以下步骤操作:

  1. 在 CCAI 平台门户中,依次点击 设置 > 开发者设置。 如果您没有看到设置 菜单,请点击 菜单

  2. 前往 Webhooks 窗格,然后将 Webhooks 开关切换到“开启”位置。

  3. 对于 网址,请输入网络钩子网址。此网址是接收实时通知的端点。请确保此 Webhook 可以接收 HTTP 请求。

  4. 点击生成 。系统会生成主密钥,这是用于对传入的 Webhook 载荷进行身份验证和验证的主要安全令牌。 它充当保护 Webhook 通信的主要手段。

  5. 复制令牌并将其保存在安全的位置。

  6. 生成辅助密钥。辅助密钥充当备份或故障切换安全令牌。它作为一项额外的安全措施提供,旨在提高 Webhook 通知的可靠性和可用性。如果主密钥因任何原因泄露或使用时出现问题,辅助密钥可以接管并继续确保通信。

  7. 复制令牌并将其保存在安全的位置。

  8. 点击保存

轮替密钥

作为安全最佳实践,请定期轮替 Webhook 密钥。此过程包括为主 Webhook 和辅助 Webhook 生成新密钥,并在应用中更新这些密钥,以便继续无缝接收通知。

在完成 Webhook 的初始设置后,您无法直接生成新的主密钥,但可以生成新的辅助密钥并轮替密钥以更改它们。

如需轮替密钥,请按以下步骤操作:

  1. 在 CCAI 平台门户中,依次点击 设置 > 开发者设置。 如果您没有看到设置 菜单,请点击 菜单

  2. 点击轮替密钥

  3. 点击保存

生成新密钥

如需轮替密钥以获得两个新密钥,请按以下步骤操作:

  1. 在 CCAI 平台门户中,依次点击 设置 > 开发者设置。 如果您没有看到设置 菜单,请点击 菜单

  2. 点击生成 以生成新的辅助密钥。

  3. 点击轮替密钥 ,将新的辅助密钥设为主密钥。

  4. 点击生成 以生成第二个新的辅助密钥,该密钥将替换旧的主密钥。

  5. 点击保存