Subscriptions API

Subscription endpoints 用于管理 workspace subscriptions、它们的 state、testing 和 delivery logs。

GET /api/subscriptions

返回当前 workspace/account 的 subscriptions。

参数：无。列表由 backend 按当前 selected workspace 过滤。

Payload: 无。

响应：SubscriptionView[]。

POST /api/subscriptions

按 rules 或 template 直接创建 subscription。

参数：无。

Direct trigger subscription payload:

字段	必填	说明
template	否	Direct mode 中通常为 null 或省略。
rules	是	Rules 数组。至少需要一条 rule。
rules[].trigger	是	Trigger fullname。
rules[].conditions	是	用于 rule 过滤的 conditions object。
resources	是	Resource fullnames 数组。
actions	否	Delivery actions。
meta.title	否	Subscription title。
state	否	on 或 off。

Template subscription payload:

字段	必填	说明
template.id	是	Template id。
template.inputs	是	Template input schema 的 values。
template.topics	是	Selected topic names。
resources	是	Resource fullnames 数组。
actions	否	Delivery actions。
meta.title	否	Subscription title。
state	否	on 或 off。

响应：SubscriptionView。

GET /api/subscriptions/:id

返回 subscription。

参数：

参数	位置	说明
id	Path	Subscription id。

Payload: 无。

响应：SubscriptionView。

PUT /api/subscriptions/:id

更新 subscription。

参数：

参数	位置	说明
id	Path	Subscription id。

Payload: 与 POST /api/subscriptions 相同结构。

响应：SubscriptionView。

DELETE /api/subscriptions/:id

删除 subscription。

参数：

参数	位置	说明
id	Path	Subscription id。

Payload: 无。

响应：HTTP 204 No Content，响应体为空。

PUT /api/subscriptions/:id/state

修改 subscription state。

参数：

参数	位置	说明
id	Path	Subscription id。

Payload:

字段	必填	说明
state	是	subscription 的目标状态：on 或 off。

响应：

字段	必填	说明
state	是	subscription 的实际状态：on、off 或 blocked。
issue	否	当前状态的问题或状态原因（如有）。

POST /api/subscriptions/test

测试现有 subscription 或 draft subscription。

参数：无。

Payload:

字段	必填	说明
subscription	二选一	Existing subscription id。
draft	二选一	与 subscription.save.params 相同结构的 draft payload。
ruleIndex	否	要测试的 rule index。
mode	否	preview 或 send。
input	否	Raw source item/test input。
test.source	否	Source item object。
test.itemIndex	否	Source item index。
test.match.hash	否	Existing match hash。
test.match.index	否	Existing match index。

响应：SubscriptionTestResult。

GET /api/subscriptions/alerts/history

返回当前 workspace 的 subscription logs。

参数：

参数	位置	说明
limit	Query	50、100、250 或 500。
status	Query	delivered、failed、rate_limited、blocked。
direction	Query	before 或 after。
datetime	Query	Cursor date-time。

Payload: 无。

响应：SubscriptionAlertLog[]。

GET /api/subscriptions/:id/alerts/history

返回指定 subscription 的 logs。

参数：

参数	位置	说明
id	Path	Subscription id。
limit	Query	50、100、250 或 500。
status	Query	可选 status 过滤器。
direction	Query	before 或 after。
datetime	Query	Cursor date-time。

Payload: 无。

响应：SubscriptionAlertLog[]。