profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

Quick startJSON 与 Claude 代码组件 Zod 拉取

REST API

REST API 概览get连接网站 APIgetGET /routesgetGET /routegetGET /blocksget获取带有 CEL 缓存的区块getGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}get获取内容变更 SSEpatchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatch修补 CSV
All Systems Operational
Powered Byprofound-logo
Theme

获取内容变更 SSE

用于网站内容变更信号的 Server-Sent Events 流。

一个用于网站内容变更事件的长连接 Server-Sent Events (SSE) 流。每个事件都会通知客户端立即重新验证。这取代了在无服务器平台上会超时的 tRPC 订阅。

认证: API 密钥(仅当服务器设置 require_schema_api_key = true 时才需要)。

查询参数

参数类型必填说明
websiteIduuid否目标网站;默认为 Host 请求头/配置。
api_keystring否作为 x-api-key 请求头的替代方案。

行为

  • Content-Type: text/event-stream。
  • 每 15 秒发送一次保活注释。
  • 对于 website_id 与解析出的租户匹配的每一次内容变更,都会发送一条消息事件;事件的 data: 负载是以 JSON 序列化的变更内容。其他网站的变更会被过滤。
  • 连接会无限期保持打开,并且在流的整个生命周期内不会占用数据库连接。

示例

curl -N '{CMS_API_URL}/content-changes?websiteId=<uuid>' \
  -H 'x-api-key: <key>'

-N 会禁用 curl 缓冲,使事件在到达时立即显示。

错误

  • 400 — 无法解析或无效的 websiteId
  • 401 — 无效的 API 密钥
  • 500 — 连接池故障
Continue Reading
Previous‹GET /dataset/{schema_name}NextPATCH /dataset/{schema_name}›