Offline Sync

⚡ Built-in — Platform Built-in

Batch sync endpoint for offline-first clients (PWA). Idempotent per op, identity-mapped via the sync_registry. Push-only create-forward in v1, two-way ready. Pull (server→client) restores registry-tracked resources with their client_uid mapping.

⚡ Built-in — No Setup Required This integration is built into the WebsitePublisher platform. All endpoints are available immediately — no API key needed.

Endpoints (3)

POST ping

Connectivity + auth liveness check. Returns server time (ISO 8601).

No input parameters required.

POST sync

Process a batch of offline operations. Idempotent per op_id, partial success. Failed ops stay client-queued.

Field	Type	Required	Description
`client_id`	string	✓ Yes	Device/installation id (ULID).
`ops`	array	✓ Yes	Operations. Each op: {op_id, kind, resource_type?, client_uid?, deleted?, payload}.

POST pull

Pull current server state for registry-tracked resources (server→client). Returns each resource with its client_uid mapping + full data. v1: blog_post. Additive (STATUS_SYNCED only); deletions are not reported back in v1.

Field	Type	Required	Description
`resource_types`	array	No	Limit to these resource types, e.g. ["blog_post"]. Omit for all pullable types.
`since`	string	No	ISO 8601 timestamp; only resources synced after this (incremental pull).

MCP Tool Names

When using this integration through an AI assistant (Claude, ChatGPT, Cursor, etc.), the endpoints are available as MCP tools:

Endpoint	MCP Tool Name
ping	`offline_sync_ping`
sync	`offline_sync_sync`
pull	`offline_sync_pull`

← Back to all integrations