AsyncAPI channel · Circle
· Circle Realtime WebSocket API (Beta)
NotificationChannel
Realtime notifications for a signed-in community member. ActionCable identifier channel "NotificationChannel"; the underlying pub/sub stream is notification-channel-{community_member_id}.
Provider:CircleAsyncAPI: v2.6.0Spec: Circle Realtime WebSocket API (Beta)Operations: 1Messages: 3
Channel address
NotificationChannel
Operations
subscribe
receiveNotifications
Receive realtime notification events for the member.
Messages
newNotification
A new notification was created for the member.
Content-Type:
updateNewNotificationCount
The member's unread notification count changed.
Content-Type:
resetNewNotificationCount
The member's unread notification count was reset.
Content-Type:
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.