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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Papercups

Papercups Realtime Chat API (WebSocket / Phoenix Channels)

Bidirectional realtime live chat over Phoenix WebSocket channels. Clients join conversation, conversation-lobby, and account-room channels and exchange shout (message), messages:seen, and presence events for two-way messaging.

Documentation Provider Profile APIs.io AsyncAPI GitHub

Papercups Realtime Chat API (WebSocket / Phoenix Channels) is one of 7 APIs that Papercups publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

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

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

The API connects through a single server, app.papercups.io/socket/websocket (wss).

5 operations 4 channels 8 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://app.papercups.io/socket/websocket
Contact
API Evangelist
License
MIT
Resource Areas
1

Channels & Operations 5

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

Channels 5
SUB
conversation:{conversation_id}
Receive broadcast messages and acknowledgements.
receiveConversationEvents 1 param body
PUB
conversation:{conversation_id}
Send a message (and read receipts) into the conversation.
sendShout 1 param body
SUB
conversation:lobby:{customer_id}
Receive new-conversation notifications.
receiveLobbyEvents 1 param body
SUB
room:{account_id}
Receive Phoenix Presence state and diffs for agent availability.
receivePresence 1 param body
PUB
phoenix
Keep the WebSocket connection alive.
sendHeartbeat body

Messages & Schemas 8

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

Shout
message
A new chat message broadcast to a conversation channel.
MessagesSeen
message
Marks agent messages in the conversation as seen.
PhxJoin
message
Phoenix channel join request.
PhxReply
message
Phoenix acknowledgement reply (status ok/error).
PresenceState
message
Full Phoenix Presence state for agent availability.
PresenceDiff
message
Incremental Phoenix Presence join/leave diff.
Heartbeat
message
Phoenix socket keepalive on the phoenix topic.
PhoenixEnvelope
array
Phoenix Channels v2 serializer envelope: [joinref, ref, topic, event, payload].

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

papercups-asyncapi.yml Raw ↑

Other APIs Papercups publishes across the network.

Papercups Notifications & Webhooks API
AE Profile APIs.io
Papercups Webhooks
AE Profile APIs.io
Papercups Conversations API
AE Profile APIs.io
Papercups Customers API
AE Profile APIs.io
Papercups Messages API
AE Profile APIs.io
Papercups Users API
AE Profile APIs.io
#Real-Time#WebSocket#Phoenix Channels
← Back to P APIs
API Details
ID
papercups:realtime-chat
Base URL
wss://app.papercups.io/socket/websocket
Docs
https://docs.papercups.io/chat
Provider
Papercups
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=realtime-chat&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/realtime-chat"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Papercups Realtime Chat API (WebSocket / Phoenix Channels), 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.