聊天 API 平台的 Webhook

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

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

启用网络钩子

如需启用网络钩子,请按以下步骤操作:

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

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

  3. 网址(网址)部分,输入网络钩子网址。此网址是接收实时通知的端点。请确保此 webhook 可以接收 HTTP 请求。

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

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

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

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

  8. 点击保存

轮替密文

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

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

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

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

  2. 点击轮替 Secret

  3. 点击保存

生成新的密文

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

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

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

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

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

  5. 点击保存