Webhook

订阅资源发布或知识库更新

POST /api/webhooks/endpoints/{id}/subscriptions
POST/api/webhooks/endpoints/{id}/subscriptions

要求 Cookie、CSRF、owner 与 api-token 强验证。已审核端点必须启用,目标当前公开;资源与知识库合计最多 100 个订阅。省略 targetKind 保留资源协议:维度内 OR、跨维度 AND,加载器和版本匹配同一物理发布。知识库独立流不接受发布筛选。新订阅从锁定的当前序号之后开始;改地址、轮换密钥、停用/启用及应用撤权均取消旧任务并推进两种订阅边界。

网站 Cookie 会话 + CSRF + 二次验证(api-token,300 秒);请在同源网站环境调用

路径参数

idstring必填

长度 ≥ 1

请求体 必填

application/json
bodyobject

方案 1 · object

targetKindstring可选
可选值"resource"
resourceSlugstring必填

长度 ≥ 1 · 长度 ≤ 200

eventsstring[]可选默认值 ["release.published","release.updated","release.withdrawn"]

条目数 ≥ 1 · 条目数 ≤ 100

[]string
可选值"release.published""release.updated""release.withdrawn"

长度 ≥ 1 · 长度 ≤ 100

loadersstring[]可选默认值 []

条目数 ≤ 100

[]string

长度 ≥ 1 · 长度 ≤ 100

mcVersionsstring[]可选默认值 []

条目数 ≤ 100

[]string

长度 ≥ 1 · 长度 ≤ 100

releaseTypesstring[]可选默认值 ["release"]

条目数 ≥ 1 · 条目数 ≤ 100

[]string
可选值"release""beta""alpha"

长度 ≥ 1 · 长度 ≤ 100

方案 2 · object

targetKindstring必填
可选值"knowledge_base"
knowledgeBaseSlugstring必填

长度 ≥ 1 · 长度 ≤ 200

eventsstring[]可选默认值 ["knowledge.published","knowledge.updated","knowledge.page.published","knowledge.page.updated","knowledge.page.withdrawn","knowledge.withdrawn","knowledge.archived","knowledge.restored"]

条目数 ≥ 1 · 条目数 ≤ 100

[]string
可选值"knowledge.published""knowledge.updated""knowledge.page.published""knowledge.page.updated""knowledge.page.withdrawn""knowledge.withdrawn""knowledge.archived""knowledge.restored"

长度 ≥ 1 · 长度 ≤ 100

返回值

成功;无额外 data 信封。

subscriptionobject必填

方案 1 · object

idstring必填
resourceIdstring必填
resourceSlugstring | null必填
eventsstring[]必填
[]string
可选值"release.published""release.updated""release.withdrawn"
loadersstring[]必填
[]string
mcVersionsstring[]必填
[]string
releaseTypesstring[]必填
[]string
可选值"release""beta""alpha"
createdAtstring必填

格式:date-time

方案 2 · object

idstring必填
targetKindstring必填
可选值"knowledge_base"
knowledgeBaseIdstring必填
knowledgeBaseSlugstring | null必填
eventsstring[]必填
[]string
可选值"knowledge.published""knowledge.updated""knowledge.page.published""knowledge.page.updated""knowledge.page.withdrawn""knowledge.withdrawn""knowledge.archived""knowledge.restored"
loadersstring[]必填

条目数 ≤ 0

[]string
mcVersionsstring[]必填

条目数 ≤ 0

[]string
releaseTypesstring[]必填

条目数 ≤ 0

[]string
createdAtstring必填

格式:date-time

响应头

Cache-Controlstring可选
可选值"no-store"
接口信息

接口: POST /api/webhooks/endpoints/{id}/subscriptions
operationId: createWebhookSubscription

要求 Cookie、CSRF、owner 与 api-token 强验证。已审核端点必须启用,目标当前公开;资源与知识库合计最多 100 个订阅。省略 targetKind 保留资源协议:维度内 OR、跨维度 AND,加载器和版本匹配同一物理发布。知识库独立流不接受发布筛选。新订阅从锁定的当前序号之后开始;改地址、轮换密钥、停用/启用及应用撤权均取消旧任务并推进两种订阅边界。

参数:

  • path id(必填)
  • body targetKind
  • body resourceSlug
  • body events
  • body loaders
  • body mcVersions
  • body releaseTypes
  • body knowledgeBaseSlug