← Back to toolkits
Ably logo

Ably

Ably is a real-time messaging platform helping developers build live features, including chat and data synchronization, with global scalability and robust reliability for modern applications

developer tools

Tools (25)

  • Query Batch Presence

    Queries the presence states of multiple Ably channels in a single request, retrieving member presence details for the specified channels. Channel names are separated by commas by default, with an optional alternative separator.

    Inputs: channels, separator

  • Query Batch Presence History

    Query presence history for multiple Ably channels, with optional start and end times and forwards or backwards ordering. Returns up to 100 messages per channel by default, with a limit of 1,000 per channel; channels not found are omitted.

    Inputs: end, limit, start, channels, direction

  • Delete Channel Subscription

    Unsubscribes a device or client from push notifications for a specified channel, or across all channels if no channel is provided. Deletion is asynchronous, so subscriptions may briefly remain visible.

    Inputs: channel, client_id, device_id

  • Get Channel Details

    Retrieves status and occupancy metadata for a specific Ably channel, including connection, presence, publisher, and subscriber metrics. The request can activate the channel and requires channel-metadata permission.

    Inputs: channel_id

  • Get Channel History

    Retrieves a page of message history for a specified Ably channel, with time range, limit, and direction filters. Results follow the requested direction, which defaults to backwards.

    Inputs: end, limit, start, direction, channel_id

  • Get Channel Presence

    Tool to obtain the set of members currently present for a channel. Use when you need to check which clients are currently connected and active on a specific Ably channel.

    Inputs: limit, format, clientId, channel_id, connectionId

  • Get Message Versions

    Retrieves a page of historical versions of a specific Ably channel message, including the original and subsequent updates or deletes. Versions may include timestamps, action types, and client IDs.

    Inputs: serial, channel_id

  • Get Channel Presence History

    This tool retrieves the history of presence messages for a specified channel in Ably. It allows you to query presence events on a channel within a given time period.

    Inputs: end, limit, start, direction, channel_id

  • Get Push Device Registration

    Retrieves a device's push registration by device ID, including available platform, state, recipient, and metadata fields.

    Inputs: format, device_id, X_Ably_Version

  • Get Ably Service Time

    This tool retrieves the current server time from Ably's service in milliseconds since the epoch. It is particularly useful for time synchronization and generating valid TokenRequest timestamps to prevent replay attacks. The endpoint supports multiple content types, handles HTTP errors, network issues, and is a fundamental tool for ensuring accurate timing in Ably applications.

  • Get Application Stats

    Retrieve a page of Ably application usage statistics by minute, hour, day or month, with optional time range, direction and limit. Results can include message, connection, channel, API request, push and token request metrics; pagination links are not returned.

    Inputs: end, unit, limit, start, direction

  • List Channels

    Tool to enumerate all active channels in the Ably application. Use when you need to discover available channels or monitor channel activity. Returns paginated results and is heavily rate-limited. Can return either channel names only or full channel details with occupancy data.

    Inputs: by, limit, format, prefix

  • List Push Channels

    Lists a page of Ably channels with at least one subscribed device for push notifications.

    Inputs: format, x_ably_version

  • List Push Channel Subscriptions

    Lists a page of push channel subscriptions filtered by channel, client ID, or device ID, with pagination links; at least one filter is required. Client and device filters can be combined when concat filters is enabled.

    Inputs: limit, channel, client_id, device_id, concat_filters

  • List Registered Push Devices

    List a page of Ably push device registrations, optionally filtered by device ID or client ID. Returns available pagination links; the limit controls page size.

    Inputs: limit, format, clientId, deviceId

  • Patch Push Device Registration

    Partially update an existing Ably push device registration. Ably permits changes to client ID, metadata and push recipient; supplied structured values replace rather than merge with existing values.

    Inputs: id, format, clientId, deviceId, metadata, platform, pushState, formFactor, deviceSecret, xAblyVersion, pushRecipient

  • Batch Publish Messages

    Tool to batch publish messages to multiple channels in parallel. Use when you need to send the same set of messages to multiple channels simultaneously for efficient broadcasting.

    Inputs: channels, messages

  • Publish Message to Channel

    Publishes a message to a specified Ably channel with a string or JSON object payload and an optional event name and client ID. An optional message ID can be used for idempotent publishing. The result includes the channel and message ID.

    Inputs: client_id, channel_id, event_name, message_id, message_data, push_notification

  • Publish Push Notification

    Tool to publish a push notification directly to device(s) via Ably's Push Notifications API. Use when you need to send push notifications to specific devices identified by device ID, client ID, or platform-specific tokens. The API returns HTTP 204 on success with no response body.

    Inputs: push, recipient

  • Batch Publish Push Notifications

    Tool to batch publish push notifications directly to specific recipients. Use when you need to send multiple push notifications efficiently in a single request. Supports up to 10,000 notifications per batch.

    Inputs: items

  • Register Push Device

    Register an iOS, Android, or browser device with Ably to receive push notifications. Provide the device details and push recipient information; a successful registration returns the registered device's details.

    Inputs: id, metadata, platform, client_id, push_state, form_factor, device_secret, push_recipient

  • Request Access Token

    Request an Ably access token with optional capabilities, client ID and lifetime. If capability is omitted, the request asks for full wildcard access.

    Inputs: ttl, nonce, key_name, client_id, timestamp, capability

  • Unregister All Push Devices

    Unregister matching Ably push devices, optionally filtering by device ID or client ID, but not both. Their push channel subscriptions are also deleted; removal is asynchronous.

    Inputs: client_id, device_id

  • Unregister Push Device

    Unregister a single Ably push device by device ID. Its push channel subscriptions are also deleted; removal is asynchronous.

    Inputs: format, device_id, X-Ably-Version

  • Update Push Device Registration

    Upsert an Ably push device registration, creating it or replacing an existing registration. Existing registrations are largely immutable: client ID, metadata, and push recipient are updatable, while changes to other fields may fail.

    Inputs: id, metadata, platform, client_id, device_id, push_state, form_factor, device_secret, push_recipient