Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Create in Bindings

Binds a bus Subscription's matching events to a channel: each event the Subscription matches is published to the channel, with the event's…

Binds a bus Subscription's matching events to a channel: each event the Subscription matches is published to the channel, with the event's CloudEvents type as the message event and its data as the payload. The Subscription itself is an Events Resource (sylphx.events.v1); this call only names the channel it feeds, and replaces the Subscription's earlier binding.

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/subscription-bindings
  • Scope realtime:write
  • Effect write — a successful call changes state.
  • Collection bindings
  • Host https://api.realtime.sylphx.com

#Request

FieldTypeWhat it is
subscriptionstringThe Events Subscription's resource name. Required.
channelstringThe channel its events are published to, namespace:name. Required.

#Response

FieldTypeWhat it is
subscriptionstringThe Subscription bound.
channelstringThe channel it feeds.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.realtime.sylphx.com/v1/subscription-bindings" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channel":"…","subscription":"…"}'