Ably Delete Push Device
Unregister push devices. This permanently removes the device registration and all its channel subscriptions. Pass device_id to remove a single device, or client_id to remove ALL devices for that client. At least one of device_id or client_id is required. List registered push devices first to find device IDs before deleting.
Ably Get Channels
Get Ably channels. Pass channel_id to get metadata for a single channel (occupancy, status). Omit channel_id to list all active channels in the app. Use 'prefix' to filter by channel name prefix, 'by=value' for full details including occupancy. Channel names from this listing are the IDs used in message, presence, and subscription tools. Returns: channel name, isActive, status (occupancy metrics, connections).
Ably Get Messages
Get message history for an Ably channel. Requires channel_id (the channel name from channel listing). Messages are only available if persistence is enabled for the channel. Use start/end for time-range queries. Default returns most recent messages (backwards). Returns: items[] with name (event name), data (payload), timestamp, id, clientId, encoding.
Ably Get Presence
Get presence information for an Ably channel. By default returns the set of members currently present on the channel. Set history=true to get the presence event history (enter/leave/update events over time). Use client_id or connection_id to filter current members. Returns: items[] with clientId, connectionId, data, action (for history), timestamp.
Ably Get Push Channels
List all channels that have at least one push notification subscriber. Useful for discovering which channels are being used for push notifications. Returns: a list of channel names.
Ably Get Push Devices
Get push notification device registrations. Pass device_id to get full details of a single registered device. Omit device_id to list all devices registered for push notifications. Use client_id to filter by the client identity that registered the device. Returns: id, platform (ios/android/browser), formFactor, push.recipient, clientId, metadata.
Ably Get Push Subscriptions
List push notification channel subscriptions. At least one filter is required: channel, device_id, or client_id. Filter by channel name, device ID, or client ID — list push channels or push devices to discover valid values. Shows which devices/clients are subscribed to receive push notifications from which channels. Returns: items[] with channel, deviceId or clientId.
Ably Get Stats
Get usage statistics for the Ably application. Stats are aggregated across all channels and cover messages published/received, connections, channels opened, API requests, push notifications, and data transferred. Use unit to set granularity (minute/hour/day/month) and start/end for time ranges. Useful for monitoring usage, quota tracking, and capacity planning. Returns: items[] with intervalId, all (messages, data), channels, connections, apiRequests, push.
Ably Get Time
Get the current Ably server time in milliseconds since the Unix epoch. Useful for synchronizing clocks between client and server, or for constructing time-range queries for messages and stats. Returns: a JSON array with a single element — the timestamp in ms.
Ably Publish Message
Publish a message to an Ably channel. All subscribers to the channel will receive this message in real time. Requires channel_id (channel name), name (event type), and data (payload). Returns empty on success (HTTP 2xx). If the channel doesn't exist, it is created automatically.
Ably Publish Push
Send a push notification directly to a device or client's devices. This bypasses channels — sends to the specified recipient immediately. Provide a recipient (deviceId, clientId, or raw transport target) and notification content. The device must be registered for push with a valid push transport. Returns empty on success.
Ably Request Token
Request an Ably token for client-side authentication. Tokens are short-lived credentials that can be given to untrusted clients. The token inherits capabilities from the API key but can be scoped down via the capability parameter. Use this to generate tokens for mobile/web clients that shouldn't hold the root API key. Returns: token string, keyName, issued timestamp, expires timestamp, capability, clientId.
Ably Reset Device Token
Reset the update token for a registered push device. After resetting, the device must re-authenticate its registration. Use when a device's update token may be compromised or needs rotation. Returns: the updated device details with new updateToken.
Ably Subscribe Push
Subscribe a device or all devices for a client to receive push notifications from a channel. The device must already be registered for push notifications. Provide channel plus either device_id (single device) or client_id (all devices for that client). Returns: the subscription object with channel and deviceId/clientId.
Ably Unsubscribe Push
Remove push notification channel subscriptions. Specify device_id or client_id plus optionally a channel. Without channel, removes ALL subscriptions for the device/client. The device registration itself is preserved — only the channel subscription is removed. List push channel subscriptions first to find active subscriptions.
Ably Upsert Push Device
Register or update a push notification device. To create: provide id, platform, and push_recipient (the device token/registration). To update an existing device: provide device_id plus the fields to change (clientId, metadata, push.recipient). Only clientId, metadata, and push.recipient are mutable after creation. Returns: the full device registration object.
