Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Publish in Channels
Publishes a message to a channel.
Publishes a message to a channel. The namespace must exist. The server publishes regardless of client_publish. A repeated Sylphx-Effect-Id publishes once.
Not available yet. Sylphx Realtime is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
POST https://api.realtime.sylphx.com/v1/channels:publish - Scope
realtime:publish - Effect
write— a successful call changes state. - Collection channels
- Host
https://api.realtime.sylphx.com
#Request
| Field | Type | What it is |
|---|---|---|
channel | string | The channel, namespace:name: the name is 1 to 128 characters of a-z A-Z 0-9 - _. = and no *. Required. |
event | string | The application's event name, 1 to 64 characters. Required. |
data | value | The JSON payload, at most 64 KiB encoded. |
#Response
| Field | Type | What it is |
|---|---|---|
message | Message | The published message; its cursor is empty in an ephemeral namespace. |
#Message
| Field | Type | What it is |
|---|---|---|
channel | string | The channel, namespace:name. |
cursor | string | The message's cursor: opaque, ordered within the channel, and the value to resume from. Empty in an ephemeral namespace. |
event | string | The application's event name, for example move. 1 to 64 characters. |
data | value | The JSON payload, at most 64 KiB encoded. |
publisher | string | The user id of the publisher; empty when a server published without one. |
publish_time | timestamp | When the service accepted the message. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.realtime.sylphx.com/v1/channels:publish" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"channel":"…","event":"…"}'