Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Whop Realtime WebSocket API

Bidirectional realtime WebSocket for Whop apps - custom app messages and chat/feed updates - connected and authenticated through the @whop/react and @whop/api SDKs. Whop does not publish a raw wss:// endpoint URL; the base URL shown is a modeled placeholder (see the AsyncAPI document).

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

Tagged areas include WebSocket, Realtime, and Apps. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

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

The API connects through a single server, realtime.whop.com (wss).

4 operations 3 channels 6 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Base URL
wss://realtime.whop.com
Resource Areas
1

Channels & Operations 4

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

Channels 4
SUB
app/messages
Receive custom app messages for subscribed targets.
receiveAppMessage body
PUB
app/messages
Send a custom app message to a target.
sendAppMessage body
SUB
chat/feed
Receive realtime chat / feed updates.
receiveFeedMessage body
SUB
connection/status
Observe websocket connection status changes.
receiveConnectionStatus body

Messages & Schemas 6

The contract defines 6 schemas that model the data carried by its messages. The most detailed are FeedMessage (4 properties), AppMessage (4 properties), ConnectionStatus (1 property). Each schema is shown below with its type and property counts.

AppMessage
message
A custom message broadcast between app clients with a target.
FeedMessage
message
A realtime chat or feed update delivered to subscribed clients.
ConnectionStatus
message
A websocket connection lifecycle event.
AppMessage
object
Custom app message envelope broadcast over the websocket.
4 properties 1 required
FeedMessage
object
Realtime chat / feed message.
4 properties
ConnectionStatus
object
Websocket connection lifecycle status.
1 property 1 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

whop-asyncapi.yml Raw ↑

Other APIs Whop publishes across the network.

Whop GraphQL API
Whop Checkout Configurations API
Whop Companies API
Whop Memberships API
Whop Payments API
Whop Plans API
Whop Products API
Whop Promo Codes API
Whop Transfers API
Whop Users API
Whop Webhooks API