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

Pusher Channels API

Pub/sub channels over WebSocket (client) and HTTP (server publish). Public, private, and presence channels supported. WebSocket endpoint at ws-{cluster}.pusher.com. Cluster hostnames include eu, us2, us3, ap1, ap2, ap3, etc.

Pusher Channels API is one of 5 APIs that Pusher publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Pub-Sub, WebSockets, HTTP, and Messaging. The published artifact set on APIs.io includes API documentation, pricing, and an AsyncAPI specification.

This event API exposes 16 operations across 14 channels, and defines 21 schemas. It is described by AsyncAPI 2.6.0, at version 7.0.0.

The API connects through a single server, ws-{cluster}.pusher.com:443 (wss).

16 operations 14 channels 21 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
7.0.0
Base URL
https://api-{cluster}.pusher.com/apps/{app_id}
Contact
Resource Areas
1

Channels & Operations 16

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

Channels 16
SUB
pusher/connection_established
Receive connection-established acknowledgement
onConnectionEstablished body
SUB
pusher/error
Receive a protocol error
onError body
SUB
pusher/ping
Receive a heartbeat ping
onPing body
PUB
pusher/ping
Send a heartbeat ping
sendPing body
SUB
pusher/pong
Receive a heartbeat pong reply
onPong body
PUB
pusher/pong
Send a heartbeat pong reply
sendPong body
PUB
pusher/signin
Authenticate the current connection as a user
sendSignin body
SUB
pusher/signin_success
Receive sign-in confirmation
onSigninSuccess body
PUB
pusher/subscribe
Subscribe to a channel
sendSubscribe body
PUB
pusher/unsubscribe
Unsubscribe from a channel
sendUnsubscribe body
SUB
pusher_internal/subscription_succeeded
Receive subscription confirmation
onSubscriptionSucceeded body
SUB
pusher/subscription_error
Receive a subscription error
onSubscriptionError body
SUB
pusher_internal/member_added
Receive presence-channel member-added notification
onMemberAdded body
SUB
pusher_internal/member_removed
Receive presence-channel member-removed notification
onMemberRemoved body
SUB
channel/event
Receive an application channel event
onChannelEvent body
PUB
channel/client_event
Trigger a client event on an authorized channel
sendClientEvent body

Messages & Schemas 21

The contract defines 21 schemas that model the data carried by its messages. The most detailed are ConnectionEstablishedData (2 properties), MemberAddedData (2 properties), SigninSuccessData (2 properties), ErrorData (2 properties). Each schema is shown below with its type and property counts.

PusherConnectionEstablished
message
Server-sent connection acknowledgement.
PusherError
message
Server-sent protocol error.
PusherPing
message
Heartbeat ping (sent either direction).
PusherPong
message
Heartbeat pong reply.
PusherSignin
message
Client-sent user sign-in.
PusherSigninSuccess
message
Server-sent sign-in acknowledgement.
PusherSubscribe
message
Client-sent channel subscription request.
PusherUnsubscribe
message
Client-sent channel unsubscription.
PusherInternalSubscriptionSucceeded
message
Server-sent confirmation of subscription.
PusherSubscriptionError
message
Server-sent subscription failure.
PusherInternalMemberAdded
message
Server-sent presence-channel member-added event.
PusherInternalMemberRemoved
message
Server-sent presence-channel member-removed event.
ChannelEvent
message
Server-delivered application event on a public, private, presence, or cache channel.
EncryptedChannelEvent
message
Server-delivered event on a private-encrypted- channel; payload is libsodium secretbox-encrypted.
ClientEvent
message
Client-published event on a private or presence channel. Event name must start with client-.
ConnectionEstablishedData
object
2 properties 2 required
ErrorData
object
2 properties 1 required
SigninSuccessData
object
2 properties
SubscriptionSucceededData
object
Inner data for pusherinternal:subscriptionsucceeded.
MemberAddedData
object
2 properties 1 required
MemberRemovedData
object
1 property 1 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

pusher-asyncapi.yml Raw ↑

Other APIs Pusher publishes across the network.

Pusher Beams API
Pusher Channels API
Pusher Events API
Pusher Users API
Where this information came from

This is an independent, third-party profile of Pusher Channels 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.