Skip to main content
Ably logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 25
  • Triggers: 0
  • Slug: ABLY
  • Version: 20261101_00

Tools

Slug: ABLY_BATCH_PRESENCEQueries 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.

Input Parameters

string
required
Comma-separated list of channel names to query presence for
string
Character used to separate channel names (default is comma)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_BATCH_PRESENCE_HISTORYQuery 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.

Input Parameters

integer
End time in milliseconds since epoch
integer
Maximum number of messages to return per channel (default 100, max 1000)
integer
Start time in milliseconds since epoch
array
required
List of channel names to query presence history for
string
Direction of results (backwards or forwards)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_DELETE_CHANNEL_SUBSCRIPTIONUnsubscribes 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.

Input Parameters

string
Optional channel name to filter subscriptions. If not provided, subscriptions across all channels for the specified device_id or client_id will be deleted.
string
Client ID to filter subscriptions. At least one of device_id or client_id must be provided. Cannot be used together with device_id.
string
Device ID to filter subscriptions. At least one of device_id or client_id must be provided. Cannot be used together with client_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_GET_CHANNEL_DETAILSRetrieves 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.

Input Parameters

string
required
The ID of the channel to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_GET_CHANNEL_HISTORYRetrieves 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.

Input Parameters

integer
The end of the query interval as a time in milliseconds since the epoch
integer
The maximum number of records to return. A limit greater than 1,000 is invalid
integer
The start of the query interval as a time in milliseconds since the epoch
string
The direction of this query. The direction determines the order of the returned result array
string
required
The ID of the channel to retrieve history for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_GET_CHANNEL_PRESENCETool 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.

Input Parameters

integer
Maximum number of presence members to return. Default is 100.
string ("json" | "jsonp" | "msgpack" | "html")
Response format enum.
string
Filter presence members by client ID
string
required
The Channel’s ID for which to retrieve presence information
string
Filter presence members by connection ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_GET_MESSAGE_VERSIONSRetrieves 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.

Input Parameters

string
required
The message serial identifier (format: timestamp-counter@connectionId:counter)
string
required
The ID of the channel containing the message

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_GET_PRESENCE_HISTORYThis 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.

Input Parameters

integer
The end of the query interval as a time in milliseconds since the epoch. Defaults to current time.
integer
The maximum number of records to return. Maximum value is 1000.
integer
The start of the query interval as a time in milliseconds since the epoch
string
The direction of results. Can be either ‘backwards’ or ‘forwards’.
string
required
The channel name to get presence history for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_GET_PUSH_DEVICERetrieves a device’s push registration by device ID, including available platform, state, recipient, and metadata fields.

Input Parameters

string ("json" | "jsonp" | "msgpack" | "html")
Response format options for the API
string
required
Device’s ID. Unique identifier for the device registration.
string
The version of the API you wish to use. If not specified, the default version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_GET_SERVICE_TIMEThis 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_GET_STATSRetrieve 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.

Input Parameters

integer
Latest time in milliseconds since epoch for stats retrieval. Times are rounded down based on the unit parameter. If omitted, defaults to current time
string
Time interval granularity for stats aggregation. Must be ‘minute’, ‘hour’, ‘day’, or ‘month’. Defaults to ‘minute’
integer
Maximum number of stats records to return (1-1000). Defaults to 100. Use with pagination for larger datasets
integer
Earliest time in milliseconds since epoch for stats retrieval. Times are rounded down based on the unit parameter. If omitted, stats are retrieved from the beginning of available data
string
Query direction determining result order. ‘backwards’ returns newest first (default), ‘forwards’ returns oldest first

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_LIST_CHANNELSTool 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.

Input Parameters

string ("id" | "value")
Channel enumeration options.
integer
Maximum number of channels to return. Default is 100, maximum is 1000.
string ("json" | "jsonp" | "msgpack" | "html")
Response format options for the API.
string
Filter to return only channels whose name starts with the given prefix

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_LIST_PUSH_CHANNELSLists a page of Ably channels with at least one subscribed device for push notifications.

Input Parameters

string ("json" | "jsonp" | "msgpack" | "html")
Response format enum for Ably API.
string
The version of the Ably API you wish to use. When not specified, the default API version is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_LIST_PUSH_CHANNEL_SUBSCRIPTIONSLists 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.

Input Parameters

integer
The maximum number of records to return. Maximum value is 1000.
string
Filter to restrict to subscriptions associated with that channel. At least one of channel, client_id, or device_id must be specified.
string
Filter to restrict to subscriptions associated with that clientId. Cannot be used with device_id unless concat_filters is True. At least one of channel, client_id, or device_id must be specified.
string
Filter to restrict to subscriptions for that deviceId. Cannot be used with client_id unless concat_filters is True. At least one of channel, client_id, or device_id must be specified.
boolean
When set to true, allows combining client_id and device_id filters to find all subscriptions matching either filter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_LIST_REGISTERED_PUSH_DEVICESList a page of Ably push device registrations, optionally filtered by device ID or client ID. Returns available pagination links; the limit controls page size.

Input Parameters

integer
The maximum number of records to return. Default is 100, maximum is 1000
string ("json" | "jsonp" | "msgpack" | "html")
Response format options.
string
Optional filter to restrict to devices associated with that clientId
string
Optional filter to restrict to devices associated with that deviceId

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_PATCH_PUSH_DEVICE_REGISTRATIONPartially 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.

Input Parameters

string
Unique identifier for the device generated by the device itself
string
The response format you would like (json, jsonp, msgpack, html)
string
Optional trusted client identifier for the device
string
required
Device’s ID - the unique identifier for the device to update
object
Optional metadata object for this device. The metadata for a device may only be set by clients with push-admin privileges and will be used more extensively in the future with smart notifications
string ("ios" | "android" | "browser")
Enum for platform types.
string ("Active" | "Failing" | "Failed")
Enum for push state.
string ("phone" | "tablet" | "desktop" | "tv" | "watch" | "car" | "embedded")
Enum for form factor types.
string
Secret value for the device
string
The version of the API you wish to use
object
Model for push recipient details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_PUBLISH_BATCH_MESSAGESTool 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.

Input Parameters

array
required
Array of channel names to publish messages to. Maximum 100 channels.
array
required
Array of messages to publish. Maximum 1000 messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_PUBLISH_MESSAGE_TO_CHANNELPublishes 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.

Input Parameters

string
Optional client identifier to associate with the message.
string
required
The name of the channel to publish the message to.
string
Optional event name/type for the message.
string
Optional unique message ID for idempotent publishing.
string
required
The message payload. Can be a string or a JSON object.
object
Optional push notification configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_PUBLISH_PUSH_NOTIFICATIONTool 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.

Input Parameters

object
Push notification payload details.
object
required
Push recipient details for a device. Must specify at least one identifier (client_id, device_id, device_token, or registration_token).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_PUBLISH_PUSH_NOTIFICATIONS_BATCHTool 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.

Input Parameters

array
required
Array of push notification items to publish. Maximum 10,000 notifications per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_REGISTER_PUSH_DEVICERegister 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.

Input Parameters

string
required
Unique identifier for the device generated by the device itself. This is a client-generated ID that uniquely identifies the device.
object
Optional metadata object for this device. The metadata may only be set by clients with push-admin privileges and will be used for smart notifications.
string ("ios" | "android" | "browser")
required
Platform of the push device. Must be one of: ios, android, or browser.
string
Optional trusted client identifier for the device. Used to associate the device with a specific client in your Ably app.
string ("Active" | "Failing" | "Failed")
State types for push devices.
string ("phone" | "tablet" | "desktop" | "tv" | "watch" | "car" | "embedded")
required
Form factor of the push device. Must be one of: phone, tablet, desktop, tv, watch, car, or embedded.
string
Secret value for the device. Used for device authentication.
object
required
Push recipient details for the device. Contains transport type and platform-specific configuration like device tokens or web push endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_REQUEST_ACCESS_TOKENRequest an Ably access token with optional capabilities, client ID and lifetime. If capability is omitted, the request asks for full wildcard access.

Input Parameters

integer
Time-to-live for the token in milliseconds. Defaults to 60 minutes (3600000ms) if not specified.
string
Random nonce string for token request uniqueness. Prevents replay attacks. If not provided, Ably generates one.
string
required
The key name comprises of the app ID and key ID of an API key. Format: appId.keyId (e.g., ‘rLhKFg.1Hf06Q’)
string
Optional client identifier to associate with this token. When set, the token can only be used by the specified client ID.
integer
Token request timestamp in milliseconds since epoch. If not provided, Ably will use the current server time. Used for token request validation.
string
JSON-stringified capability text specifying permissions. Use ’{"":[""]}’ for full access, or specify specific channels and operations. Must be a valid JSON string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_UNREGISTER_ALL_PUSH_DEVICESUnregister 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.

Input Parameters

string
Optional filter to restrict to devices associated with that clientId. Cannot be used with device_id.
string
Optional filter to restrict to devices associated with that deviceId. Cannot be used with client_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_UNREGISTER_PUSH_DEVICEUnregister a single Ably push device by device ID. Its push channel subscriptions are also deleted; removal is asynchronous.

Input Parameters

string ("json" | "jsonp" | "msgpack" | "html")
Enum for response format options
string
required
The unique identifier of the device to unregister from push notifications. This is the device ID that was used when the device was originally registered.
string
The version of the Ably API you wish to use. Example: ‘1.2’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ABLY_UPDATE_PUSH_DEVICEUpsert 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.

Input Parameters

string
required
Unique identifier for the device generated by the device itself. This should match device_id.
object
Optional metadata object for this device. May only be set by clients with push-admin privileges.
string ("ios" | "android" | "browser")
required
Platform of the push device (ios, android, or browser).
string
Optional trusted client identifier for the device.
string
required
Device’s ID. This is the unique identifier for the device being registered/updated.
string ("Active" | "Failing" | "Failed")
Push device state types.
string ("phone" | "tablet" | "desktop" | "tv" | "watch" | "car" | "embedded")
required
Form factor of the push device (phone, tablet, desktop, tv, watch, car, or embedded).
string
Secret value for the device.
object
required
Push recipient details for the device, including transport type and device/registration tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not