Webhook 订阅

Webhook 允许您在特定事件发生时接收实时通知。本指南将介绍如何通过 Genstore 的 REST APIs 或嵌入式应用配置来订阅和管理 Webhook。

使用 REST API 订阅 Webhooks 主题

您可以通过 REST API 方便快捷地创建和管理 Webhook 订阅。以下示例展示了如何创建一个新的 Webhook，订阅订单创建事件。

创建 Webhook 订阅

要创建一个新的 Webhook 订阅，您需要提供通知的目的地址和您感兴趣的主题名称：

curl -d '{"webhook":{"address":"https://appURL:topicName","topic":"orders/create"}}' \
-X POST "https://{shop}.genmystore.com/api/202412/app/webhooks" \
-H "X-Genstore-Access-Token: {access_token}" \
-H "Content-Type: application/json"

成功的响应示例：

HTTP/1.1 201 Created
{
  "webhook": {
    "id": 8589934859,
    "address": "https://appURL:topicName",
    "topic": "orders/create",
    "createTime": "2024-10-30T16:19:13-04:00",
    "updateTime": "2024-10-30T16:19:13-04:00",
  }
}

管理 Webhook 订阅

以下是一些常用的 REST API 操作，可以帮助您管理您的 Webhook 订阅：

REST API	VERSION	METHOD	URI
创建 Webhook	202412	POST	/app/webhooks
删除 Webhook	202412	DEL	/app/webhooks/
更新 Webhook	202412	PUT	/app/webhooks/
查询 Webhook 列表	202412	GET	/app/webhooks
获取 Webhook 实体	202412	GET	/app/webhooks/
获取 Webhook 数量	202412	GET	/app/webhooks/count

接收 Webhook 消息

当应用接收到 Webhook 消息时，应快速返回 200 OK 响应，以确认已成功接收消息。任何不在 200 范围内的响应（包括 3XX HTTP 重定向代码）均表示未成功接收 Webhook 消息，Genstore 将视为错误响应。

使用嵌入式应用管理 Webhooks 订阅

该部分内容将在后续版本中详细介绍，敬请期待。