Ably integration

Unregisters a single device from push notifications by device ID. Returns empty response on success.

Unregisters multiple devices matching the filter. Use deviceId or clientId (not both) to specify which devices to remove.

Retrieves details of a registered push device. Returns device id, platform, form factor, metadata, push state, and recipient information.

Lists registered push devices with optional filtering by deviceId or clientId. Returns paginated array of device registration objects.

Partially updates a push device registration. Only sends changed fields. Returns the complete updated device object.

Registers a device for push notifications. Provide platform, form factor, and push recipient details. Returns device registration with updateToken.

Resets the update token for a push device registration. Invalidates the old token and returns updated device details with a new token.

Updates an existing push device registration. Mutable fields include clientId, metadata, and push.recipient. Returns updated device details.

Publishes messages to multiple channels in a single HTTP request. Supports up to 100 channels and 1000 messages per batch specification. Maximum request body is 2MiB.

Retrieves message history from an Ably channel. Filter by time range, limit results, and specify order. Returns messages with timestamps, IDs, and full payload. Requires history to be enabled on the channel.

Retrieves the latest version of a specific message by its serial. Returns the current state after any updates, deletes, or appends.

Retrieves all historical versions of a message. Returns the original and all updates or deletes ordered by version serial (oldest to newest).

Publishes a message to an Ably channel for real-time delivery to all subscribers. Include event name and data payload. Messages are persisted for history if enabled. Returns message ID and timestamp on success.

Updates, deletes, or appends to an existing message. Specify action type (1=update, 2=delete, 5=append) and new content. Returns the version serial of the operation.

Retrieves the annotation summary for a message filtered to a specific client ID. Returns aggregated annotation types relevant to that client with clipped=true indicating filtered results.

Retrieves all annotations on a specific message. Returns paginated list of reactions, votes, and other annotations ordered from earliest to latest.

Publishes annotations (reactions, votes, etc.) on a specific message. Supports create and delete actions with various aggregation types.

Retrieves presence data for multiple channels in a single request. Returns an array of objects each containing the channel name and its presence members.

Gets the current presence set showing all clients on a channel. Returns client IDs, connection IDs, and optional presence data. Use to show who's online in chat rooms, active players in games, or live viewers.

Retrieves presence history showing enter, leave, and update events over time. Filter by time range. Returns timeline of who was present and when they joined/left.

Lists push channel subscriptions with filtering by channel, clientId, or deviceId. Returns paginated array of subscription objects.

Subscribes a device or client to push notifications on a channel. Either deviceId or clientId must be provided.

Removes push channel subscriptions. Unsubscribe by channel, deviceId, or clientId. Omitting channel removes all subscriptions for the target.

Gets channel status including whether it's active, presence occupancy count, and connection metrics. Useful for monitoring and capacity planning.

Lists all active channels in your Ably application. Filter by prefix to find specific channel types. Returns channel names with pagination support.

Publishes push notifications to multiple recipients in a single request. Each spec can target different recipients with different payloads. Maximum 10,000 notifications per request.

Publishes a push notification directly to a specific device or client. Supports generic notifications and platform-specific overrides for APNs, FCM, and web push.

Requests a new authentication token for Ably clients. Specify TTL, capabilities (channel permissions), and optional client ID. Returns token for secure client-side authentication.

Revokes tokens matching specified target criteria such as clientId or revocationKey. Forces affected clients to re-authenticate. Returns revocation details with timestamps.

Lists all channels that have at least one push subscription. Returns a paginated array of channel name strings.

Retrieves usage statistics for your Ably app. Get message counts, peak connections, API calls, and bandwidth. Aggregate by minute, hour, day, or month.

Returns the current Ably server time as milliseconds since the Unix epoch. Useful for clock synchronization and verifying connectivity. No authentication required.