developer-center/guides/api/webhooks

Webhooks 是一种用于接收即时通知的机制，当特定事件发生时，服务器会自动向您的应用程序发送 HTTP POST 请求。这使得您能够实时接收数据更新，无需不断轮询服务器。

如何使用 Webhooks

1. 创建 Webhook

   • 首先，您需要在您的应用程序中设置一个端点，用于接收 Webhook 通知。
   • 然后，在相关 API 的设置中，配置 Webhook，指定您的端点 URL。

2. 接收通知

   • 当相关事件发生时，服务器会将包含事件数据的 POST 请求发送到您的端点。
   • 您需要确保您的端点能够正确处理这些请求，并做出相应的处理。

示例

假设您正在使用我们的 API 来管理订单，以下是一个简单的示例：

• 设置 Webhook：

  • 配置 API，指定您的 Webhook 端点为 https://yourapp.com/webhook-endpoint。

• 接收订单更新：

  • 当订单状态发生变化时，例如从 "已支付" 变为 "已发货"，服务器会向 https://yourapp.com/webhook-endpoint 发送一个 POST 请求。

扩展阅读

如果您想了解更多关于 Webhooks 的信息，可以阅读以下文章：

• Webhooks 简介
• 如何在您的应用程序中使用 Webhooks

Webhooks 机制示意图