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 startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API 概要getウェブサイトを CMS API に接続するgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostCSV 投稿patchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /content-changes (SSE)

ウェブサイト向けコンテンツ変更シグナルの Server-Sent Events ストリーム。

ウェブサイト向けのコンテンツ変更イベントを配信する長寿命の Server-Sent Events (SSE) ストリームです。各イベントはクライアントにただちに再検証するよう指示します。これは、サーバーレスプラットフォームでタイムアウトしていた tRPC サブスクリプションの代替となります。

認証: API キー(サーバーが require_schema_api_key = true を設定している場合のみ必要)。

クエリパラメーター

パラメーター型必須備考
websiteIduuidno対象のウェブサイト。Host ヘッダーまたは設定にフォールバックします。
api_keystringnox-api-key ヘッダーの代替。

動作

  • Content-Type: text/event-stream。
  • 15 秒ごとにキープアライブ用のコメントを送信します。
  • 解決されたテナントと website_id が一致する各コンテンツ変更ごとに message イベントを 1 件送信し、イベントの 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}›