How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Circle Realtime WebSocket API

Beta ActionCable (Rails) WebSocket surface for realtime chat and notifications, connected at wss://app.circle.so/cable with a member Bearer access token and a whitelisted Origin header. Exposes a NotificationChannel (new-notification and unread-count events) and three chat channels for member-level room updates, room-wide messages, and thread events.

Circle Realtime WebSocket API is one of 8 APIs that Circle publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include WebSocket, Real-Time, Chat, Notification, and ActionCable. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 4 operations across 4 channels, and defines 6 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.

The API connects through a single server, app.circle.so/cable (wss).

4 operations 4 channels 6 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0
Base URL
wss://app.circle.so/cable
Resource Areas
1

Channels & Operations 4

Across 4 channels, the API surfaces 4 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 4
SUB
NotificationChannel
Receive realtime notification events for the member.
receiveNotifications body
SUB
ChatRoomMemberChannel
Receive chat room creation and update events for the member.
receiveMemberChatEvents body
SUB
ChatRoomChannel
Receive messages, updates, and deletions for a chat room.
receiveRoomMessages body
SUB
ChatThreadChannel
Receive thread messages and status events for the member.
receiveThreadEvents body

Messages & Schemas 6

The contract defines 6 schemas that model the data carried by its messages. Each schema is shown below with its type and property counts.

NewNotification
message
A new notification was created for the member.
UpdateNewNotificationCount
message
The member's unread notification count changed.
ResetNewNotificationCount
message
The member's unread notification count was reset.
ChatRoomEvent
message
A chat room was created or updated for the member.
ChatMessage
message
A message was sent, updated, or deleted in a chat room.
ChatThreadEvent
message
A thread message or status update was delivered.

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

circle-community-asyncapi.yml Raw ↑

Other APIs Circle publishes across the network.

Circle Admin - Courses API
Circle Admin - Events API
Circle Admin - Members API
Circle Admin - Posts API
Circle Admin - Spaces API
Circle Headless - Auth API
Circle Headless - Member API
Where this information came from

This is an independent, third-party profile of Circle Realtime WebSocket API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.