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

PubNub REST API

Single REST surface for publish, subscribe (long-poll), presence, history, signal, and App Context. Pub/Sub key authentication. SDKs available for 50+ languages and platforms.

PubNub REST API is one of 2 APIs that PubNub publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Pub/Sub, Presence, Messaging, History, and REST. The published artifact set on APIs.io includes API documentation, pricing, and an AsyncAPI specification.

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

The API connects through a single server, ps.pndsn.com (https).

6 operations 6 channels 22 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
3.0.0
Base URL
https://ps.pndsn.com
Resource Areas
1

Channels & Operations 6

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

Channels 6
SUB
message
Receive published messages on a channel.
receiveMessage body
SUB
signal
Receive signals on a channel.
receiveSignal body
SUB
presence
Receive presence events for a channel.
receivePresence body
SUB
file
Receive file events on a channel.
receiveFile body
SUB
message-action
Receive message action events on a channel.
receiveMessageAction body
SUB
app-context-events
Receive App Context (object) events.
receiveAppContextEvent body

Messages & Schemas 22

The contract defines 22 schemas that model the data carried by its messages. The most detailed are PresenceStateChangePayload (10 properties), PresenceIntervalPayload (10 properties), PresenceLeavePayload (7 properties), PresenceJoinPayload (7 properties). Each schema is shown below with its type and property counts.

Message
message
A user-published message delivered to channel subscribers.
Signal
message
A signal event delivered to channel subscribers (payload ≤ 64 bytes).
PresenceJoin
message
PresenceLeave
message
PresenceTimeout
message
PresenceStateChange
message
PresenceInterval
message
FileEvent
message
MessageActionEvent
message
UuidMetadataEvent
message
ChannelMetadataEvent
message
MembershipEvent
message
Timetoken
string
17-digit PubNub timetoken — number of 100-nanosecond intervals since Unix epoch. Encoded as a string to preserve precision.
ListenerMessage
object
SDK listener event object delivered for "message" and "signal" events. Fields as documented in the JavaScript SDK publish-and-subscribe API reference.
7 properties 3 required
PresenceJoinPayload
object
7 properties 7 required
PresenceLeavePayload
object
7 properties 7 required
PresenceTimeoutPayload
object
7 properties 7 required
PresenceStateChangePayload
object
10 properties 8 required
PresenceIntervalPayload
object
Interval event — replaces individual join/leave/timeout events when channel occupancy exceeds the "Announce Max" threshold. With Presence Deltas enabled the ev…
10 properties 6 required
FileEventPayload
object
File event delivered to subscribers when a file is uploaded to a channel. Contains the publishing channel, an optional message description, and the file descri…
6 properties 2 required
MessageActionEventPayload
object
Message action event payload as documented in the addMessageAction / removeMessageAction API reference. Delivered via subscribe listeners to clients subscribed…
5 properties
AppContextEventPayload
object
App Context (object metadata) event envelope. Delivered via subscribe when user, channel, or membership metadata is created, updated, or deleted. Structure as…
4 properties 3 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

pubnub-asyncapi.yml Raw ↑

Other APIs PubNub publishes across the network.

PubNub Functions