Actions (10)
Channels · 8
- Get channel infoGET /apps/{app_id}/channels/{channel_name}
Fetch attributes for a specific channel (including occupancy and requested info attributes).
documented - Get channel stats (deprecated)GET /apps/{app_id}/channels/{channel_name}/stats
Deprecated endpoint for retrieving channel statistics; use the current channel info endpoint instead.
documented - List channelsGET /apps/{app_id}/channels
Fetch a hash of occupied channels, optionally filtered by a prefix and with optional per-channel attributes.
documented - List users in channelGET /apps/{app_id}/channels/{channel_name}/users
Fetch user IDs currently subscribed to a presence channel.
documented - Publish event to channel (deprecated)POST /apps/{app_id}/channels/{channel_name}/events
Deprecated alternative to POST /events; triggers an event on a channel with query-parameter semantics.
documented - Terminate user connectionsPOST /apps/{app_id}/users/{user_id}/terminate_connections
Terminate all connections established by the given user.
documented - Trigger batch eventsPOST /apps/{app_id}/batch_events
Publish multiple events in a single API call to one or more channels (up to 10 per call on multi-tenant clusters).
documented - Trigger eventPOST /apps/{app_id}/events
Publish a single event to one or more channels.
documented
Beams · 2
- Publish notification to interestsPOST /publish_api/v1/instances/{instance_id}/publishes/interests
Publish a push notification to devices subscribed to the given interests.
documented - Publish notification to usersPOST /publish_api/v1/instances/{instance_id}/publishes/users
Publish a push notification to devices associated with one or more user IDs.
documented